Metadata-Version: 2.4
Name: genai-scaffold
Version: 0.1.4.1
Summary: CLI tool to scaffold production-ready Generative AI projects
Author-email: Akinyemi Arabambi <yemiarabambi@gmail.com>
License-Expression: MIT
Project-URL: Repository, https://github.com/2abet/genai_scaffold
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# genai-scaffold

**genai-scaffold** is a Python CLI tool that bootstraps production-ready Generative AI project structures with best practices and modular organization out-of-the-box.

![PyPI](https://img.shields.io/pypi/v/genai-scaffold)
![License](https://img.shields.io/pypi/l/genai-scaffold)

---

## ✨ Features

- 🔧 Clean and extensible project structure.
- 🧠 Support for LLM clients (GPT, Claude, etc.)
- 🧱 Prompt engineering modules scaffolded
- 📦 Auto-generates config, data, notebooks, and examples
- 🐍 Ready for unit testing and CI/CD integration
- ⚡ Fast to get started, easy to extend

---

## 📦 Installation

You can install it via [PyPI](https://pypi.org/project/genai-scaffold):

```bash
pip install genai-scaffold
```

Or using `pipx`:

```bash
pipx install genai-scaffold
```

---

## 🚀 Usage

To scaffold a new Generative AI project:

```bash
genai-scaffold myproject
```

This creates:

```
myproject/
├── config/
├── src/
│   ├── llm/
│   ├── prompt_engineering/
│   ├── utils/
│   └── handlers/
├── data/
│   ├── cache/
│   ├── prompts/
│   ├── outputs/
│   └── embeddings/
├── examples/
├── notebooks/
├── requirements.txt
├── setup.py
├── Dockerfile
└── README.md
```

---

## 🧰 Project Structure

Your scaffolded project includes:

- `src/llm/`: LLM client implementations (e.g. GPT, Claude)
- `src/prompt_engineering/`: Prompt templates and chaining
- `src/utils/`: Rate limiting, caching, logging, token counting
- `config/`: YAML config for models, prompts, logging
- `data/`: Inputs, outputs, embeddings, cache
- `examples/`: Working usage examples
- `notebooks/`: Jupyter notebooks for prototyping

---

## 🔄 Updating Your Scaffold Tool

To update:

```bash
pip install --upgrade genai-scaffold
```

---

## 🛠 Roadmap

- [ ] Interactive CLI with `typer`
- [ ] LangChain/LlamaIndex integration options
- [ ] Built-in Streamlit UI
- [ ] Prompt chaining module
- [ ] Test coverage + GitHub Actions

---

## 🤝 Contributing

Pull requests are welcome! For major changes, open an issue first to discuss what you’d like to change.

---

## 📄 License

This project is licensed under the MIT License.

---

## 🙌 Acknowledgements

Inspired by real-world GenAI use cases in enterprise environments. Built for speed, clarity, and collaboration.
