Sortium 1.5.0

A utility to sort files by type and date.

Sortium

Sortium is a Python utility that automatically organizes files in a directory based on their type (e.g., Images, Documents, Videos, etc.) and optionally by their last modified date.

---

Table of Contents

• Features
• Installation
  • PyPI
• Running Tests
• Author
• License
• Contributing
• Documentation and Issues

---

Features

• Automatically organizes files into folders by type:
  • Images, Documents, Videos, Music, Others
• Optional sorting by last modified date within each category
• Optional flattening of subdirectories into a single level before sorting

---

Installation

PyPI

To install from PyPI:

pip install sortium

To install from source:

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

---

Running Tests

To run the test suite with coverage reporting:

pytest src/tests --cov=src/sortium

Refer to the Test Suite README for test structure and guidelines.

---

Author

Sarthak Goyal Email: [e-mail]

---

License

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

---

Contributing

Contributions are welcome.

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, conventional messages
5. Open a pull request with a description of your changes

Please follow the Conventional Commits specification. Ensure all code is linted and tested before submitting.

---

Documentation and Issues

This project uses Sphinx for documentation.

• To build the documentation locally:

  cd docs
  make html
  

  View the generated files at docs/_build/html/index.html.

• Online documentation: View Documentation

• For issues and feature requests: Open an issue

---