Metadata-Version: 2.4
Name: yish-cli
Version: 0.1.1
Summary: FastAPI scaffolding CLI
Requires-Python: >=3.11
Requires-Dist: rich>=15.0.0
Requires-Dist: typer>=0.26.8
Description-Content-Type: text/markdown

# 🦇 Yish CLI

> Opinionated FastAPI scaffolding CLI for modern Python backend development.

Yish CLI is a lightweight command-line tool that bootstraps FastAPI projects using a predefined project structure and development conventions.

Instead of manually creating folders, Docker files, configuration files, and boilerplate for every project, Yish CLI generates a production-ready project in seconds.

---

## ✨ Features

- 🚀 FastAPI project scaffolding
- 📦 Docker & Docker Compose
- 🐍 UV-ready project
- 📁 Opinionated project structure
- ⚙️ Environment configuration
- 📝 README generation
- 🔒 GitIgnore generation
- 🧩 Easily extendable templates

---

## 📂 Generated Structure

```
project/
│
├── app/
│   ├── api/
│   ├── core/
│   ├── db/
│   ├── models/
│   ├── schemas/
│   ├── repositories/
│   ├── services/
│   ├── providers/
│   ├── middlewares/
│   ├── dependencies/
│   ├── exceptions/
│   ├── logging/
│   ├── cache/
│   ├── utils/
│   ├── workers/
│   └── main.py
│
├── Dockerfile
├── docker-compose.yaml
├── pyproject.toml
├── .env.example
├── README.md
└── .gitignore
```

---

## 🚀 Installation

### Local Development

```bash
git clone https://github.com/<your-username>/yish-cli.git

cd yish-cli

uv sync

uv pip install -e .
```

---

## Usage

Create a new project.

```bash
yish new my-awesome-api
```

Result:

```
my-awesome-api/
```

ready for development.

---

## Philosophy

Yish CLI follows one simple philosophy.

> **Stop creating the same project over and over again.**

It automates the repetitive setup so developers can immediately start building features instead of project scaffolding.

---

## Roadmap

- [x] FastAPI project scaffolding
- [ ] Multiple templates
- [ ] Project placeholder replacement
- [ ] Service generator
- [ ] Route generator
- [ ] Repository generator
- [ ] AI project template
- [ ] RAG template
- [ ] Authentication template

---

## Tech Stack

- Python
- Typer
- Rich
- UV

---

## License

MIT License

---

## Author

Built with ❤️ by Justine Juan.