Sortium 1.3.1

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 by their last modified date.

---

📚 Table of Contents

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

🚀 Features

• ✅ Organize files into folders based on their type (e.g., Images, Documents, Videos, Music, Others)
• 📅 Optionally further sort files by their last modified date within each category
• 📁 Optionally flatten subdirectories into a single folder

---

🛠️ Installation

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

# Install in editable mode
pip install -e .

🧪 Run Tests

pytest src/tests --cov=src/Structa

---

👤 Author

Sarthak Goyal 📧 [e-mail]

---

📄 License

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

🤝 Contributing

Contributions are welcome and appreciated! 🎉

If you'd like to improve this project, here's how to get started:

1. Fork the repository.
2. Create a new branch for your feature or fix.
3. Write tests for your changes.
4. Commit your changes with clear messages.
5. Open a pull request and describe what you’ve changed.

Please follow conventional commit guidelines and ensure your code is linted and tested before submitting.

---

📚 Documentation & Issues

This project is documented using Sphinx.

• 📖 Documentation: Full documentation can be viewed in the HTML version in _build/html/ after running make html.

• 🐛 Report Bugs / Request Features: Open an Issue

---

📦 PyPI (Coming Soon)

This project is not yet available on PyPI, but you can install it locally:

git clone https://github.com/Sarthak-G0yal/SortPy.git
cd SortPy
pip install -e .

Once published, you’ll be able to install it with:

pip install sortpy

Stay tuned for updates! 🚀