FastAPI scaffolding CLI
Project description
๐ฆ 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
git clone https://github.com/<your-username>/yish-cli.git
cd yish-cli
uv sync
uv pip install -e .
Usage
Create a new project.
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
- 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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file yish_cli-0.1.1.tar.gz.
File metadata
- Download URL: yish_cli-0.1.1.tar.gz
- Upload date:
- Size: 11.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f2351a614cf4159c908542556671a80916897abb694a2f88c37944b7cf4fff03
|
|
| MD5 |
8efded65566963f7d2af8a598b120544
|
|
| BLAKE2b-256 |
7bc9849922dc05c15d7b1b82501e7a1b16b6ceb10b9cbfe68b8f2ce64f0d4e5e
|
File details
Details for the file yish_cli-0.1.1-py3-none-any.whl.
File metadata
- Download URL: yish_cli-0.1.1-py3-none-any.whl
- Upload date:
- Size: 24.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6f86d4203a8ec65974c47e95a1d4ef97cc1d161af334f83f3a3811d9373641d8
|
|
| MD5 |
22cec83b39d473b0fd7e6e3e52637963
|
|
| BLAKE2b-256 |
80f9cf53ae93342a30b677064e0d8034ea6b8dd06ccdf638d7241fd1cbae96a0
|
