https://github.com/2kabhishek/orgpy
Organize your digital mess. 🗂🗃
https://github.com/2kabhishek/orgpy
files organizer python tool utility
Last synced: 2 months ago
JSON representation
Organize your digital mess. 🗂🗃
- Host: GitHub
- URL: https://github.com/2kabhishek/orgpy
- Owner: 2KAbhishek
- License: gpl-3.0
- Created: 2021-02-06T06:09:03.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2026-01-20T19:41:40.000Z (5 months ago)
- Last Synced: 2026-01-20T19:41:48.487Z (5 months ago)
- Topics: files, organizer, python, tool, utility
- Language: Python
- Homepage: https://2kabhishek.github.io/orgpy
- Size: 42 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
orgpy is a `utility` that allows you to quickly organize your files in a predefined structure
## Prerequisites
Before you begin, ensure you have met the following requirements:
- You have installed the latest version of `python3`
## Installing orgpy
To install orgpy, follow these steps:
```bash
git clone https://github.com/2kabhishek/orgpy
cd orgpy
# Setup symlink, make sure target directory is added to PATH
ln -sfnv "$PWD/orgpy.py" ~/Applications/bin/orgpy
```
## Using orgpy
```bash
USAGE:
orgpy [-h] [path] [--dry-run] [-c CONFIG_FILE] [--config-path]
Organize your digital mess.
positional arguments:
path The directory path to organize. [Default: current working directory]
options:
-h, --help show this help message and exit
--dry-run Preview changes without actually moving files.
-c, --config CONFIG_FILE
Path to custom configuration file.
--config-path Show configuration file path and exit.
Visit github.com/2KAbhishek/orgpy for more.
EXAMPLE:
orgpy ~/Downloads # Organizes your downloads directory
orgpy ~/Desktop --dry-run # Preview what would be organized in desktop
```
### Configuration
orgpy automatically creates a config file at `~/.config/orgpy.json` on first run with default file categories.
You can customize this file to add your own categories or modify existing ones.
```bash
# Show config file location
orgpy --config-path
# Use custom config file
orgpy --config /path/to/custom/config.json
```
### Running Tests
The project includes a comprehensive test suite with **zero external dependencies** (uses only Python's built-in `unittest`):
```bash
# Run all tests
python3 tests/test_orgpy.py
# Or run with module discovery
python3 -m unittest discover tests -v
```
Hit the ⭐ button if you found this useful.
