Metadata-Version: 2.4
Name: heroalgorithm
Version: 0.1.0
Summary: Instant AI/ML lab problem sheets, datasets, notebooks, and algorithms vault.
Author: HeroAlgorithm Maintainer
License-Expression: MIT
Project-URL: Homepage, https://github.com/AdityaxDeore/heroalgorithm
Project-URL: Repository, https://github.com/AdityaxDeore/heroalgorithm.git
Keywords: heroalgorithm,aiml,machine-learning,problem-sheets,datasets,jupyter-notebook,algorithms,cli
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
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: Programming Language :: Python :: 3.13
Classifier: Topic :: Education
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# ⚡ HeroAlgorithm

> **Instant AI/ML Problem Sheets, Datasets & Code Vault**  
> Download, extract, and organize all your AI & Machine Learning lab assignments, problem sheets, datasets, Jupyter Notebooks (`.ipynb`), and Python scripts cleanly onto your PC with a single command.

[![PyPI Version](https://img.shields.io/pypi/v/heroalgorithm.svg)](https://pypi.org/project/heroalgorithm/)
[![Python Version](https://img.shields.io/badge/python-3.9%2B-blue.svg)](https://www.python.org/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Zero Dependencies](https://img.shields.io/badge/dependencies-0%20runtime-brightgreen.svg)]()

---

## 🌟 The Magic Experience

Install and organize all your AI/ML lab problem sheets into `C:\AIML_Assignments` in one step:

```powershell
pip install heroalgorithm; heroalgorithm
```

Or run `heroalgorithm` anytime in your terminal:

```powershell
heroalgorithm
```

And your C: drive folder is cleanly populated:

```text
C:\AIML_Assignments\
├── PS-1/
│   ├── dataset/
│   │   └── data.csv
│   ├── notebook.ipynb
│   ├── solution.py
│   └── README.md
├── PS-2/
│   ├── dataset/
│   │   └── housing.csv
│   ├── notebook.ipynb
│   ├── solution.py
│   └── README.md
└── PS-3/
    ├── dataset/
    │   └── iris.csv
    ├── notebook.ipynb
    ├── solution.py
    └── README.md
```

> **Clean & Quiet by Design:** No noisy spam or "installing file x" lines. Everything stays hidden and extracts quietly into your folder!

---

## 🚀 Key Features

- ⚡ **Bundled Offline Vault**: Problem sheets, datasets, notebooks, and solutions are packaged directly inside the package. Works 100% offline without needing GitHub.
- 📁 **Automatic C: Drive Placement**: Automatically organizes files into `C:\AIML_Assignments` on Windows (or `~/AIML_Assignments`).
- 🎯 **Selective Extraction**: Run `heroalgorithm 1` or `heroalgorithm ps-1` to unpack just Problem Sheet 1.
- 🤫 **Silent Mode**: Zero annoying logs. Use `-q` or `--quiet` for 100% silent execution.
- 🔄 **GitHub Sync (Optional)**: Connect to a remote GitHub repository anytime with `heroalgorithm config --set-repo <user>/<repo>` to sync the latest assignments.
- 🪶 **Zero Dependencies**: 100% built on Python's standard library. Instant installation.

---

## 🛠️ Usage Examples

### 1. Extract All Problem Sheets to C:\AIML_Assignments
```powershell
heroalgorithm
```

### 2. Extract Only Problem Sheet 1
```powershell
# Shorthand:
heroalgorithm 1

# Or:
heroalgorithm ps-1
```

### 3. Choose a Custom Output Folder
```powershell
heroalgorithm -o "D:\MyCollege\AI_Lab"
```

### 4. Run Completely Silently
```powershell
heroalgorithm -q
```

### 5. Preview Available Problem Sheets
```powershell
heroalgorithm list
```

### 6. Configure Default Destination or Remote Repo
```powershell
# Change default destination:
heroalgorithm config --set-dest "D:\AIML_Lab"

# Connect to a GitHub repository:
heroalgorithm config --set-repo your-username/aiml-assignments

# Check active configuration:
heroalgorithm config
```

---

## 🚢 Publishing to PyPI (Step-by-Step)

The package name **`heroalgorithm`** is verified available on PyPI!

### Step 1: Build the Package
```powershell
python -m build
```
This creates the distribution files in `dist/`:
- `heroalgorithm-0.1.0-py3-none-any.whl`
- `heroalgorithm-0.1.0.tar.gz`

### Step 2: Upload to PyPI
```powershell
python -m twine upload dist/*
```
*(Enter `__token__` as the username, and paste your PyPI API Token as the password).*

Once published, anyone in the world can run:
```powershell
pip install heroalgorithm; heroalgorithm
```

---

## 📄 License

This project is licensed under the [MIT License](LICENSE).
