Back to selected work

Technical Documentation / README

Tidyup

A README for a fictional Python tool, written so new users never have to ask.

Self-initiated sample. Tidyup is fictional, not client work.

tidyup

Clean up your Downloads folder (or any folder) in seconds. tidyup moves each file into a subfolder by type: images, documents, audio, video and archives.

Requirements: Python 3.10 or later.

Installation

pip install tidyup

Quick start

# Preview the changes without moving anything
tidyup ~/Downloads --dry-run

# Sort it for real
tidyup ~/Downloads

Options

OptionWhat it does
--dry-runShows the changes without moving files.
--recursiveIncludes subfolders.
--config PATHUses your own rules file.
--undoReverts the last run.

Configuration

Create tidyup.toml to define your own categories:

[categories]
Invoices = ["pdf", "xml"]
Design = ["psd", "fig", "svg"]

Troubleshooting

  • “Permission denied”: make sure you have write access to the folder.
  • A file wasn’t moved: its extension isn’t in any category; add it to tidyup.toml.

License: MIT.

Next projectWords in Motion