File processing and organization tool — smart categorization, batch rename, duplicate detection, and directory cleanup
Project description
cleanupx
File processing and organization tool with smart categorization, batch rename, duplicate detection, and directory cleanup. Optionally generates image alt-text via vision models.
Install
pip install cleanupx
Set XAI_API_KEY in your environment to enable vision features like alt text generation (optional).
Usage
# Organize files by type
cleanupx organize --dir ~/Downloads
# Find and handle duplicates
cleanupx deduplicate --dir ~/Projects
# Generate alt text for images (requires XAI_API_KEY)
cleanupx images --dir ./photos
# Run all processing steps
cleanupx comprehensive --dir ./documents
# Scramble filenames for privacy (reversible)
cleanupx scramble --dir ./sensitive_data
What It Does
- Deduplication — SHA256 hash-based duplicate detection
- File Organization — Categorize by type: images, code, documents, archives
- Image Alt Text — Generate accessibility descriptions via vision models
- Code Extraction — Pull and analyze code snippets from files
- Filename Scrambling — Randomize names for privacy, with undo log
- PDF/DOCX Support — Process documents alongside plain text
Supported File Types
Images (jpg, png, gif, webp, bmp, tiff), code (py, js, html, css, md, json, yaml), documents (pdf, doc, docx, rtf, pptx), archives (zip, tar, gz, rar).
Structure
cleanupx/
├── cleanupx.py # CLI entry point
├── cleanupx_core/ # Core processing modules
│ ├── api/ # XAI integration
│ ├── processors/ # File type handlers
│ └── utils/ # Common utilities
└── storage/ # Experimental/archived code
Configuration
XAI_API_KEY=your-key # Required for vision features (alt text generation)
CLEANUP_OUTPUT_DIR=./out # Custom output directory
CLEANUP_LOG_LEVEL=INFO # Logging verbosity
Dependencies
Core: requests, rich, inquirer, pillow, PyPDF2, python-docx. Optional: openai, PyHEIF, rarfile.
License
MIT — Luke Steuber (luke@dr.eamer.dev)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cleanupx-2.0.3.tar.gz.
File metadata
- Download URL: cleanupx-2.0.3.tar.gz
- Upload date:
- Size: 80.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e77a9089badf57f6bb4c054c64e41f0430f3a370ad835c6c0e913c239147c040
|
|
| MD5 |
2b529624f4549fe22d6339ac87a6ad2e
|
|
| BLAKE2b-256 |
09854e31cf70472bc33fac519fffb4072664b01f201662be0de8d7d9fa42535f
|
File details
Details for the file cleanupx-2.0.3-py3-none-any.whl.
File metadata
- Download URL: cleanupx-2.0.3-py3-none-any.whl
- Upload date:
- Size: 85.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0ebed09ccbb448721e6c6b2f2aa03c4d04057215ec89f538f4403e9dcff5fd69
|
|
| MD5 |
c98106becedfdfe7a06701cfaa7aad32
|
|
| BLAKE2b-256 |
e9c9b119f86e25887c930fa7790bd39d0b2c87a400895f354bdf7b77d585140e
|