MediaSort

MediaSort provides a command-line environment designed for automated file organization. Built to be fast, flexible, and safe.

• Installation Guide
• What It Does
• How It Works
• Usage
• Configuration
• Contributing
• Contributors
• License

Follow these steps to install MediaSort locally. There are two ways to get MediaSort. Pick whichever fits you.

Currently not available. Please build from source.

Prerequisites:

Steps:

1. Clone the repository:

   git clone https://github.com/Huerte/MediaSort.git
   cd MediaSort

2. Install Dependencies: No external dependencies required for Windows.

   For Linux users, install tkinter:

   sudo apt-get install python3-tk

3. Run the application:

   python src/main.py

MediaSort automates the painful process of manually sorting your files.

Project structure:

MediaSort/
├── src/
│   ├── core/           # Core logic for organization
│   ├── utils/          # Helper utilities (file ops, settings, UI)
│   └── main.py         # Entry point
├── config.json         # User configuration (generated on first run)
├── .gitignore
└── README.md           # This file

1. Run the main script with python src/main.py.

2. Start Application — Select the target folder you want to organize. The tool will scan and display the valid files found.

3. Undo All Changes — Revert the last organization operation.
4. Settings — Configure folder mappings, file extensions, and advanced options.

5. Sorting Report — After organizing, the tool will automatically display a final summary report of successful and failed operations.

Edit the generated configuration file:

config.json

Example:

{
  "categories": {
    "Music": [".mp3", ".wav", ".flac"],
    "Videos": [".mp4", ".mkv", ".avi"]
  }
}

Contributions are welcome. Here is how to go from zero to a submitted pull request.

Prerequisites: Python 3.x and Git.

Fork and clone:

# 1. Fork the repo on GitHub, then clone your fork
git clone https://github.com/YOUR_USERNAME/MediaSort.git
cd MediaSort

# 2. Keep your fork in sync with the original
git remote add upstream https://github.com/Huerte/MediaSort.git

Branch naming:

feat/short-description    # New features
fix/short-description     # Bug fixes
docs/short-description    # Documentation only
chore/short-description   # Maintenance or refactoring

Commit messages: Use plain English. Describe what changed and why:

# Good
git commit -m "feat: add support for deep directory scanning"
git commit -m "fix: resolve duplicate file handling error"
git commit -m "docs: clarify installation steps in README"

# Avoid
git commit -m "fix stuff"
git commit -m "update"

Code style:

• Follow the existing patterns in the src/ directory.
• Keep functions short. If something is growing, split it.
• Add a comment when the purpose of something is not immediately obvious.
• Never swallow exceptions silently with a bare except: pass unless the operation is purely cosmetic.

1. Push your branch to your fork:

   git push origin feat/your-feature
   

2. Open a Pull Request against Huerte/MediaSort:main on GitHub.

3. In the PR description, briefly explain: what you changed, why, and how to test it.

4. If your change affects the app's output or behavior, update this README accordingly.

Huerte Creator

Distributed under the MIT License. See LICENSE for details.

Built to keep your directories clean and clutter-free.