Skip to main content

File processing and organization tool — smart categorization, batch rename, duplicate detection, and directory cleanup

Project description

cleanupx

Python 3.8+ License: MIT Status: Active

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


Download files

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

Source Distribution

cleanupx-2.0.4.tar.gz (80.5 kB view details)

Uploaded Source

Built Distribution

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

cleanupx-2.0.4-py3-none-any.whl (85.0 kB view details)

Uploaded Python 3

File details

Details for the file cleanupx-2.0.4.tar.gz.

File metadata

  • Download URL: cleanupx-2.0.4.tar.gz
  • Upload date:
  • Size: 80.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for cleanupx-2.0.4.tar.gz
Algorithm Hash digest
SHA256 9b7c732c5973ee1f0e292183ef49c5f4c26f75a4e273f37e826bc707686aad9e
MD5 4fbd2db61fabcc2b5963823c7be6b7af
BLAKE2b-256 451790ecf5b7fe640b747931e3e177073da069dc1a22d154e4d27e6cec4d308b

See more details on using hashes here.

File details

Details for the file cleanupx-2.0.4-py3-none-any.whl.

File metadata

  • Download URL: cleanupx-2.0.4-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

Hashes for cleanupx-2.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 29dc35cedd3e20f7a5b362231df358a1d0ebd7c87d0d5aa3a16429db9fe6a571
MD5 8dd9c06e1ac216af99025030e2e965ca
BLAKE2b-256 8deff6dc9cc7d7a5ce7318c99852d1a32d48f66d37cdb0f25277c2c91ef60eb5

See more details on using hashes here.

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