shareprep 0.1.0

Smart project cleanup and share-preparation tool for developers

SharePrep 📦✨

Internal Developer Utility

Make any development project "share-ready" in one command.

Whenever we work on software projects, many unnecessary files are automatically generated (__pycache__, .pyc, .log, .pytest_cache, etc.). These files bloat the project and are not needed when preparing a ZIP for submission, handoffs, or archiving.

SharePrep automatically scans the project directory, safely removes junk files, and optionally creates a clean .zip archive.

Core Features

• 🔍 Smart Scanning: Detects junk files specific to Python, data science, and web development.
• 🛡️ Safe Cleanup: Interactive confirmation and dry-run modes ensure no accidental deletions.
• 📦 Auto-Zipping: Packages the clean project into a .zip file, automatically ignoring .git history.
• 🐍 Library API: Import directly into automation scripts.

CLI Usage

The fastest way to clean and package your project:

# Scan, confirm, clean, and zip in one step
shareprep full

Individual Commands

Check what would be deleted without actually deleting anything:

shareprep scan

Perform a safe cleanup:

shareprep clean

Do a dry run to preview deletions:

shareprep clean --dry-run

Just create a clean ZIP file:

shareprep zip

(By default, this names the zip file after the current folder, e.g., my_project.zip)

Python Library Usage

from shareprep import scan_project, clean_project, zip_project

# Scan the current directory
summary, paths_to_delete = scan_project(".")
print(summary)

# Clean the files
clean_project(paths_to_delete)

# Create a zip
zip_project(".", "clean_archive.zip")

Development Roadmap

• Basic scanner (__pycache__, .pyc, .log)
• Safe deletion engine
• Auto-zipping feature
• Dynamic ZIP naming
• Add pytest test suite
• Add .shareprep.json config support for custom rules
• PyPI packaging & deployment workflow