Metadata-Version: 2.4
Name: chaosorg
Version: 0.1.1
Summary: A CLI tool to organize messy data science project folders
Home-page: https://github.com/chrisjaimyantony/chaosorg
Author: Chris Jaimy Antony
Author-email: Chris Jaimy Antony <chrisjaimyantony@email.com>
License: MIT License
        
        Copyright (c) 2025 Chris Jaimy Antony
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights  
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell     
        copies of the Software, and to permit persons to whom the Software is         
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in    
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR    
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,      
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE   
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER        
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN     
        THE SOFTWARE.
        
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer[all]
Dynamic: author
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

# chaosorg

Organize messy project folders with one simple command.

---

## 📁 What does it do?

`chaosorg` automatically organizes files in your project directory based on file types. It sorts files into folders like:

* `scripts/`
* `notebooks/`
* `data/`
* `models/`
* `docs/`
* `outputs/`

This keeps your project tidy, easy to navigate, and collaboration-ready.

---

## 📦 Installation

```bash
pip install chaosorg
```

Or, for local development:

```bash
git clone https://github.com/YOUR_USERNAME/chaosorg.git
cd chaosorg
pip install -e .
```

---

## 🚀 Quick Start

From your terminal:

```bash
chaosorg organize
```

---

## ⚡ Features

### ✅ Organize

```bash
chaosorg organize
```

Moves your files into categorized folders.

### 🪤 Dry Run

```bash
chaosorg organize --dry-run
```

See what *would* happen, without making any changes.

### ↺ Undo

```bash
chaosorg undo
```

Restores everything back to how it was before you ran `organize`. Only the latest organization is stored.

---

## 🔍 How Files Are Sorted

| Folder       | Extensions                     |
| ------------ | ------------------------------ |
| `scripts/`   | `.py`                          |
| `notebooks/` | `.ipynb`                       |
| `data/`      | `.csv`, `.xls`, `.xlsx`        |
| `models/`    | `.pkl`, `.joblib`, `.h5`       |
| `docs/`      | `.md`, `.txt`, `.pdf`, `.docx` |
| `outputs/`   | `.png`, `.jpg`, `.jpeg`        |

You can customize these rules by editing `FOLDER_MAP` in the source code.

---

## 🙌 Contributing

We welcome contributions! If you'd like to:

* Add support for more file types
* Build a GUI
* Improve undo history
* Polish the CLI interface

Please see [`CONTRIBUTING.md`](CONTRIBUTING.md) to get started.

---

## 👺 About

Made with love by [Chris Jaimy Antony](https://github.com/ChrisJaimyAntony) to solve the chaos of cluttered folders — especially during hackathons, ML experiments, or collaborative academic work.

---

## 🔒 License

MIT License. See `LICENSE` file for details.

---

## ✨ Links

* GitHub: [github.com/YOUR\_USERNAME/chaosorg](https://github.com/YOUR_USERNAME/chaosorg)
* PyPI: [pypi.org/project/chaosorg](https://pypi.org/project/chaosorg)
