Skip to main content

Comprehensive LLM-enhanced file processing and organization tool

Project description

cleanupx

File organization and processing tool with optional LLM features for image alt-text and content analysis.

Install

pip install cleanupx

Set XAI_API_KEY in your environment for LLM-powered features (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 LLM features
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.2.tar.gz (81.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.2-py3-none-any.whl (85.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cleanupx-2.0.2.tar.gz
  • Upload date:
  • Size: 81.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.2.tar.gz
Algorithm Hash digest
SHA256 911984252b9f8a5c2a16f04d103057425651175750d17f5e85ee084cdec225ae
MD5 a5d6aebde13a46bde691df4234455727
BLAKE2b-256 03157135bdc43ca8e71eb4efa4dad17feacc41f609b8a051947536db67e7051e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cleanupx-2.0.2-py3-none-any.whl
  • Upload date:
  • Size: 85.1 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3ec2db758ae93ef61c526398e1d293b4c989efaaaad82ca272e55237dccb47dd
MD5 824eba6cfb79c657d2289133067dc458
BLAKE2b-256 eec0680aeb483b500e5b1d3c69d7788eb8e6fa97761227df315defc96e7622d3

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