Metadata-Version: 2.4
Name: shareprep
Version: 0.2.0
Summary: Smart project cleanup and share-preparation tool for developers and students
Project-URL: Homepage, https://github.com/akashshinde0775/shareprep
Project-URL: Repository, https://github.com/akashshinde0775/shareprep
Project-URL: Issues, https://github.com/akashshinde0775/shareprep/issues
Author-email: Akash Shinde <akashshinde0775@gmail.com>
License: MIT
License-File: LICENSE
Keywords: cleanup,cli,developer-tools,packaging,productivity,project-cleaner,zip
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Requires-Dist: click>=8.1.0
Requires-Dist: rich>=13.0.0
Requires-Dist: send2trash>=1.8.0
Description-Content-Type: text/markdown

# 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:

```bash
pip install shareprep
```
## CLI Usage

### Full workflow

Scan, clean, and zip in one command:

```bash
shareprep full
```

### Individual commands

Scan a project and show cleanup summary:

```bash
shareprep scan
```

Clean removable files safely:

```bash
shareprep clean
```

Preview cleanup without deleting anything:

```bash
shareprep clean --dry-run
```

Create a clean ZIP archive:

```bash
shareprep zip
```
By default, the ZIP file is named after the current project folder.

## Python Library Usage

```python
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