shareprep 0.2.0

Smart project cleanup and share-preparation tool for developers and students

SharePrep 📦✨

SharePrep is a Python CLI tool and library that makes projects share-ready by detecting and removing unnecessary generated files, then optionally packaging the cleaned project into a ZIP archive.

Features

• Scan project folders and show cleanup summary
• Clean common junk files and folders safely
• Create ready-to-share ZIP archives
• Support Python library usage in addition to CLI usage
• Cross-platform tested on Windows, macOS, and Linux

Installation

Install directly from PyPI:

pip install shareprep

CLI Usage

Full workflow

Scan, clean, and zip in one command:

shareprep full

Individual commands

Scan a project and show cleanup summary:

shareprep scan

Clean removable files safely:

shareprep clean

Preview cleanup without deleting anything:

shareprep clean --dry-run

Create a clean ZIP archive:

shareprep zip

By default, the ZIP file is named after the current project folder.

Python Library Usage

from shareprep import scan_project, clean_project, zip_project

summary, paths_to_delete = scan_project(".")
print(summary)

clean_project(paths_to_delete)

zip_project(".", "clean_archive.zip")

Supported junk patterns

• __pycache__
• *.pyc, *.pyo, *.pyd
• *.log, *.tmp, *.bak
• .pytest_cache, .mypy_cache, .ruff_cache
• .ipynb_checkpoints
• build, dist
• node_modules, .next, .nuxt
• .DS_Store, Thumbs.db

Status

Current version: 0.2.0

Author

Akash Shinde
Python developer utility by Akash Shinde.

License

MIT License