Skip to main content

Organises a certain folder in a few seconds

Project description

Dirganise

A CLI tool written in Python that organizes a messy folder by file type.

Python License: MIT Version Platform


Features

  • Automatic sorting — moves files into categories: Images, Videos, Audio, Documents, Code, Compressed, Installers, Fonts, and Others
  • Custom rules — define your own extension-to-folder mappings via a JSON file
  • Dry-run mode — preview what would happen without touching the filesystem
  • Undo — revert the last organization with a single command
  • Conflict handling — appends a timestamp automatically if a file with the same name already exists

Installation

[!TIP] Compatibility: This program can run in every platform that supports Python 3.10+

pip install dirganise

Or clone and install locally:

git clone https://github.com/yourusername/dirganise.git
cd dirganise
pip install -e .

Usage

# Organize a folder
dirganise /path/to/folder

# Preview changes without moving anything
dirganise --dry-run

# Undo the last organization
dirganise --undo

# Use custom rules from a JSON file
dirganise --rules custom_rules.json

Options

Flag Short Description
--dry-run -n Preview changes without modifying the filesystem
--undo Revert the last dirganise operation in this folder
--rules FILE Path to a JSON file with custom extension-to-folder rules
--version -v Prints the version of dirganise being used

Default Organization Rules

Category Extensions
Images .jpg .jpeg .png .gif .webp .svg .bmp .tiff .heic
Videos .mp4 .mov .avi .mkv .wmv .flv
Audio .mp3 .wav .flac .aac .ogg .m4a
Documents .pdf .docx .xlsx .pptx .txt .odt .rtf
Code .py .js .ts .html .css .json .csv .xml .sh .bat .ps1
Compressed .zip .rar .7z .tar .gz .bz2
Executables .exe .msi .dmg .pkg .deb .rpm
Fonts .ttf .otf .woff .woff2
Others Everything else

Custom Rules

Create a .json file mapping extensions to folder names:

{
  ".psd": "Design",
  ".ai": "Design",
  ".blend": "3D",
  ".csv": "Data"
}

Custom rules override the defaults for any matching extension. All other defaults remain active.

dirganise ~/Downloads --rules my_rules.json

Undo

After every organization, dirganise saves a log file (.dirganise_op.json) in the target folder. Use it to restore the original state:

dirganise /path/to/folder --undo

The log file is automatically deleted after a successful undo.


Example

$ dirganise ~/Downloads --dry-run

 dirganise  >  /home/user/Downloads

Images/
  photo_2024.jpg
  screenshot.png

Documents/
  report.pdf
  notes.txt

Code/
  script.py

Total files to move: 5

[Preview] No changes have been made to the file system.

Development

git clone https://github.com/yourusername/dirganise.git
cd dirganise
pip install -e .

Contributions, issues, and feature requests are highly welcome. Feel free to open an issue or submit a pull request.


License

MIT © 2026

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dirganise-1.1.0.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dirganise-1.1.0-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file dirganise-1.1.0.tar.gz.

File metadata

  • Download URL: dirganise-1.1.0.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for dirganise-1.1.0.tar.gz
Algorithm Hash digest
SHA256 175ccf1cb120c982e4e60a20c9fdf31d6f04dd36807de312cefa22295bdbe9e4
MD5 bbcfa1785df573e2990554682752516a
BLAKE2b-256 875475ebbaecc4ab1c2bb0666f38f2a0805da31b618b02ec31f5670d8e8d9773

See more details on using hashes here.

Provenance

The following attestation bundles were made for dirganise-1.1.0.tar.gz:

Publisher: pypi-publish.yml on dxvampi/dirganise

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dirganise-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: dirganise-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 9.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for dirganise-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 eacd6ee82ebefc212886bb4b480bb775863e2ffd0fe0fea43165c353c412d9a4
MD5 3cd38347171c8002d15721c91942f569
BLAKE2b-256 53e20d103e15652d70efc0ee7e5e3842d04946a6fe16efed8a131d3dce39fbec

See more details on using hashes here.

Provenance

The following attestation bundles were made for dirganise-1.1.0-py3-none-any.whl:

Publisher: pypi-publish.yml on dxvampi/dirganise

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page