Metadata-Version: 2.4
Name: shareprep
Version: 0.1.0
Summary: Smart project cleanup and share-preparation tool for developers
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
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Build Tools
Requires-Python: >=3.8
Requires-Dist: click>=8.1.0
Requires-Dist: rich>=13.0.0
Description-Content-Type: text/markdown

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

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

### Individual Commands

Check what would be deleted without actually deleting anything:
```bash
shareprep scan
```

Perform a safe cleanup:
```bash
shareprep clean
```

Do a dry run to preview deletions:
```bash
shareprep clean --dry-run
```

Just create a clean ZIP file:
```bash
shareprep zip
```
*(By default, this names the zip file after the current folder, e.g., `my_project.zip`)*

## Python Library Usage

```python
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
- [x] Basic scanner (`__pycache__`, `.pyc`, `.log`)
- [x] Safe deletion engine
- [x] Auto-zipping feature
- [x] Dynamic ZIP naming
- [ ] Add `pytest` test suite
- [ ] Add `.shareprep.json` config support for custom rules
- [ ] PyPI packaging & deployment workflow