Sortium 1.4.3

A utility to sort files by type and date.

🗂️ Sortium

A Python utility to automatically sort files in a folder by their type (e.g., Images, Documents, Videos, etc.) and their last modified date.

---

📚 Table of Contents

• 🗂️ Sortium
  • 📚 Table of Contents
  • 🚀 Features
  • 🛠️ Installation
    • 📦 PyPI
  • 🧪 Run Tests
  • 👤 Author
  • 📄 License
  • 🤝 Contributing
  • 📚 Documentation & Issues

---

🚀 Features

• ✅ Automatically organizes files into folders based on type:

  • Images, Documents, Videos, Music, Others

• 📅 Optionally sort files by last modified date within each category

• 📁 Optionally flatten subdirectories into a single level before sorting

---

🛠️ Installation

📦 PyPI

Install the package from PyPI:

pip install sortium

Alternatively, install from source:

# Clone the repository
git clone https://github.com/Sarthak-G0yal/Sortium.git
cd Sortium

# Install in editable mode
pip install -e .

---

🧪 Run Tests

To run unit tests with coverage:

pytest src/tests --cov

---

👤 Author

Sarthak Goyal 📧 [e-mail]

---

📄 License

This project is licensed under the GNU General Public License v3.0.

---

🤝 Contributing

Contributions are welcome and appreciated! 🎉

To contribute:

1. Fork the repository
2. Create a new branch (feature/my-feature or fix/my-fix)
3. Write tests for your changes
4. Commit with clear and conventional messages
5. Open a pull request and describe your changes

✅ Please follow Conventional Commits and ensure your code is linted and tested before submitting.

---

📚 Documentation & Issues

This project uses Sphinx for documentation.

• 📖 Documentation: After running make html from the docs/ folder (cd docs && make html), view the docs at docs/_build/html/index.html

• 🐛 Issues / Feature Requests: Open an issue