Metadata-Version: 2.4
Name: ai-starter-kit
Version: 0.1.0
Summary: Boilerplates and starter templates for learning machine learning and deep learning.
Project-URL: Homepage, https://github.com/mikovilla/ai-starter-kit
Project-URL: Issues, https://github.com/mikovilla/ai-starter-kit/issues
Author-email: Miko Villa <dev@mikovilla.com>
License: MIT
License-File: LICENSE
Keywords: ai,boilerplate,deep-learning,machine-learning,starter-kit
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.9
Requires-Dist: click>=8.1
Provides-Extra: dev
Requires-Dist: pytest>=8.0; extra == 'dev'
Description-Content-Type: text/markdown

# ai-starter-kit

Boilerplates for learning and starting machine learning / deep learning projects. Pick a template, copy it, run it.

## Install

```bash
pip install ai-starter-kit
```

## Usage

```bash
# See available templates
ai-starter-kit list

# Copy a template into the current directory
ai-starter-kit new text_processing

# Copy into a specific folder
ai-starter-kit new text_processing --dest ./my-project
```

Each template ships with its own `requirements.txt` — install those separately once you've copied a template, since they aren't bundled as dependencies of ai-starter-kit itself.

## Available templates

| Template | Description |
|---|---|
| `text_processing` | Chains common NLP preprocessing steps (noise/punctuation removal, tokenization, stopword removal, stemming, lemmatization) behind a fluent `TextProcessor` API using NLTK. |

More templates will be added as the project grows.

## Development

To set up a local environment for running the test suite:

```powershell
# Windows
powershell -ExecutionPolicy Bypass -File .\scripts\bootstrap.ps1
```

```bash
# macOS/Linux
./scripts/bootstrap.sh
```

This creates a `.venv`, installs the package in editable mode, and pulls in dev/test dependencies (`click`, `nltk`, `pytest`). Then activate it and run the tests:

```powershell
# Windows
. .\.venv\Scripts\Activate.ps1
pytest -v
```

```bash
# macOS/Linux
source .venv/bin/activate
pytest -v
```

## Contributing

New templates are welcome. Add a folder under `src/ai_starter_kit/templates/<name>/` with a `main.py` and `requirements.txt`, then open a PR.

## License

MIT
