Enforces a Johnny-Decimal-like folder structure.
Find a file
2025-06-22 21:16:59 +08:00
src/organize Remove magic number (MAX_DELETED_FOLDER_VERSION) 2025-06-22 21:16:30 +08:00
.gitignore Initial release 2025-06-22 19:27:21 +08:00
COPYING Initial release 2025-06-22 19:27:21 +08:00
poetry.lock Initial release 2025-06-22 19:27:21 +08:00
pyproject.toml Bump version to v0.3.1 2025-06-22 21:16:59 +08:00
README.md Add trash path option 2025-06-22 20:54:11 +08:00

Organize

This program accepts an index like:

- 00: Area 1
    - 01: Category 1
    - 02: Category 2
- 10: Area 2
    - 11: Category 3

And automatically renames, creates, and deletes folders in the base path to match the index. We try our best to be safe about this, by asking for confirmation (this can be overriden) before changing any files, and using the trash can/recycle bin instead of deleting folders directly. However, nothing can be perfect, so:

USAGE OF THIS PROGRAM MAY RESULT IN DATA LOSS. MAKE A BACKUP FIRST.

Usage:

Usage: organize [OPTIONS]

Options:
  -f, --file TEXT            File path containing the organizational index
                             [default: index.md]
  -b, --base-path TEXT       Base path for organizational folders  [default:
                             ~/My Files]
  -t, --trash-path TEXT      Path for the trash folder, where None uses the
                             system default
  -r, --removed-string TEXT  If a folder's name is this, treat it as removed
                             [default: *Removed*]
  -y, --yes-to-all           Automatically answer 'Yes' to all prompts
  -d, --dry-run              Do not change any actual files, just print the
                             changes that would be made
  --help                     Show this message and exit.

  Organize  Copyright (C) 2025  Lim Ding Wen

  This program comes with ABSOLUTELY NO WARRANTY. This is free software, and
  you are welcome to redistribute it under certain conditions.

  You should have received a copy of the GNU General Public License along with
  this program. If not, see <https://www.gnu.org/licenses/>.

Licensing

This program is licensed under the GPLv3. Please see COPYING and the individual source code files for more information.

Organize README.md © 2025 by Lim Ding Wen is licensed under Creative Commons Attribution-ShareAlike 4.0 International. To view a copy of this license, visit https://creativecommons.org/licenses/by-sa/4.0/