fastapi-initializer 1.0.0__tar.gz

fastapi_initializer-1.0.0/.gitignore

@@ -0,0 +1,13 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+# Environment variables
+.env

fastapi_initializer-1.0.0/.python-version

@@ -0,0 +1 @@
+3.13

fastapi_initializer-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Dasun Nethsara
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fastapi_initializer-1.0.0/PKG-INFO

@@ -0,0 +1,225 @@
+Metadata-Version: 2.4
+Name: fastapi-initializer
+Version: 1.0.0
+Summary: An interactive CLI tool that scaffolds production-ready FastAPI projects with sensible defaults.
+Project-URL: Homepage, https://github.com/DasunNethsara-04/fastapi-initializer
+Project-URL: Repository, https://github.com/DasunNethsara-04/fastapi-initializer
+Project-URL: Issues, https://github.com/DasunNethsara-04/fastapi-initializer/issues
+Author-email: Dasun Nethsara <dasunnethsara04@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: boilerplate,cli,fastapi,initializer,project-generator,scaffold,template
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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 :: Software Development :: Code Generators
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: inquirerpy>=0.3.4
+Requires-Dist: typer>=0.9.0
+Description-Content-Type: text/markdown
+
+# FastAPI Initializer
+
+[![PyPI version](https://img.shields.io/pypi/v/fastapi-initializer.svg)](https://pypi.org/project/fastapi-initializer/)
+[![Python](https://img.shields.io/pypi/pyversions/fastapi-initializer.svg)](https://pypi.org/project/fastapi-initializer/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+An interactive CLI tool that scaffolds **production-ready FastAPI projects** with sensible defaults — so you can skip the boilerplate and start building right away.
+
+![fastapi-init demo](https://raw.githubusercontent.com/DasunNethsara-04/fastapi-initializer/main/assets/demo.gif)
+
+---
+
+## ✨ What Does It Do?
+
+Run a single command, answer a few prompts, and get a fully structured FastAPI project with:
+
+- 🗂️ **Clean project layout** - `api/`, `core/`, `models/`, `schemas/`, `services/`
+- 🗃️ **Database support** - SQLite, MySQL, or PostgreSQL
+- 🔧 **ORM of your choice** - SQLAlchemy or SQLModel
+- 🧪 **Testing setup** - pytest / pytest-asyncio with httpx, ready to go
+- 🧹 **Linter config** - Black or Ruff
+- 🐳 **Docker ready** - optional `Dockerfile` & `docker-compose.yml`
+- ⚙️ **Environment config** - pydantic-settings with `.env` support
+- 📖 **Documentation** - every folder gets a README explaining its purpose
+
+---
+
+## 📦 Installation
+
+### Install from PyPI
+
+```bash
+pip install fastapi-initializer
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv pip install fastapi-initializer
+```
+
+### Install from Source (for development)
+
+```bash
+# Clone the repository
+git clone https://github.com/DasunNethsara-04/fastapi-initializer.git
+cd fastapi-initializer
+
+# Create a virtual environment and install dependencies
+uv sync
+
+# Run the CLI directly
+uv run fastapi-init my-project
+```
+
+---
+
+## 🚀 Usage
+
+```bash
+fastapi-init my-project
+```
+
+You'll be guided through interactive prompts:
+
+```
+❯ FastAPI Initializer
+Creating project: my-project
+
+❯ What kind of database do you want to use?
+  > SQLite / MySQL / PostgreSQL / None
+
+❯ Which ORM do you want to use?
+  > SQLAlchemy / SQLModel / None
+
+❯ What linter do you want to use?
+  > Ruff / Black / None
+
+❯ What testing framework do you like to use?
+  > PyTest / pytest-async-io / None
+
+❯ Do you want to create a Docker file for this project?
+  > Yes / No
+
+✔ FastAPI project 'my-project' created successfully!
+```
+
+Then get started in seconds:
+
+```bash
+cd my-project
+uv sync
+uv run uvicorn app.main:app --reload
+```
+
+Open **http://127.0.0.1:8000/docs** to see the interactive API docs.
+
+---
+
+## 📁 Generated Project Structure
+
+The generated project follows a modular, production-style layout:
+
+```
+my-project/
+├── app/
+│   ├── api/
+│   │   ├── v1/
+│   │   │   └── users.py            # User endpoints
+│   │   ├── __init__.py              # Mounts versioned routers
+│   │   └── deps.py                  # Shared dependencies (e.g. auth)
+│   ├── core/
+│   │   ├── config.py                # App settings via pydantic-settings
+│   │   └── security.py              # OAuth2 / auth utilities
+│   ├── models/
+│   │   └── user.py                  # ORM model (SQLAlchemy / SQLModel)
+│   ├── schemas/
+│   │   └── user.py                  # Pydantic request / response models
+│   ├── services/
+│   │   └── user_service.py          # Business logic layer
+│   ├── db/
+│   │   ├── base.py                  # ORM Base class
+│   │   └── session.py               # Engine & get_session() dependency
+│   └── main.py                      # FastAPI app entry-point
+├── tests/
+│   └── test_users.py                # Smoke test with httpx
+├── .env                             # Environment variables
+├── .gitignore
+├── pyproject.toml
+├── Dockerfile                       # (optional)
+├── docker-compose.yml               # (optional)
+└── README.md                        # Auto-generated project docs
+```
+
+> **Note:** Folders like `models/`, `db/`, `tests/`, and Docker files are only generated when you select the corresponding options.
+
+### What Each Folder Does
+
+| Folder | Purpose |
+|--------|---------|
+| `app/api/` | HTTP route definitions, versioned (`v1/`, `v2/`, …). |
+| `app/core/` | App-wide settings (`Settings` class) and security helpers. |
+| `app/models/` | ORM model classes mapped to database tables. |
+| `app/schemas/` | Pydantic models for request validation and response serialisation. |
+| `app/services/` | Business-logic layer — keeps route handlers thin and testable. |
+| `app/db/` | Database engine, session factory, and `get_session()` dependency. |
+| `tests/` | Automated test suite using pytest + httpx. |
+
+---
+
+## 🛠️ Configuration Options
+
+| Prompt | Choices | What It Generates |
+|--------|---------|-------------------|
+| **Database** | SQLite, MySQL, PostgreSQL, None | `app/db/session.py` with connection URL and driver dependency |
+| **ORM** | SQLAlchemy, SQLModel, None | `app/models/` with model classes and `app/db/base.py` |
+| **Linter** | Ruff, Black, None | Adds the linter to `pyproject.toml` dependencies |
+| **Test framework** | pytest, pytest-asyncio, None | `tests/` directory with async smoke test |
+| **Docker** | Yes, No | `Dockerfile`, `docker-compose.yml`, `.dockerignore` |
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome! Here's how to get started:
+
+```bash
+# 1. Fork and clone
+git clone https://github.com/DasunNethsara-04/fastapi-initializer.git
+cd fastapi-initializer
+
+# 2. Install dependencies
+uv sync
+
+# 3. Make your changes, then test
+uv run fastapi-init test-project
+
+# 4. Submit a pull request
+```
+
+---
+
+## 📄 License
+
+This project is licensed under the [MIT License](LICENSE).
+
+---
+
+## 🙏 Acknowledgements
+
+Built with:
+
+- [FastAPI](https://fastapi.tiangolo.com/) — the framework this tool scaffolds
+- [Typer](https://typer.tiangolo.com/) — CLI framework
+- [InquirerPy](https://inquirerpy.readthedocs.io/) — interactive prompts

fastapi_initializer-1.0.0/README.md

@@ -0,0 +1,195 @@
+# FastAPI Initializer
+
+[![PyPI version](https://img.shields.io/pypi/v/fastapi-initializer.svg)](https://pypi.org/project/fastapi-initializer/)
+[![Python](https://img.shields.io/pypi/pyversions/fastapi-initializer.svg)](https://pypi.org/project/fastapi-initializer/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+An interactive CLI tool that scaffolds **production-ready FastAPI projects** with sensible defaults — so you can skip the boilerplate and start building right away.
+
+![fastapi-init demo](https://raw.githubusercontent.com/DasunNethsara-04/fastapi-initializer/main/assets/demo.gif)
+
+---
+
+## ✨ What Does It Do?
+
+Run a single command, answer a few prompts, and get a fully structured FastAPI project with:
+
+- 🗂️ **Clean project layout** - `api/`, `core/`, `models/`, `schemas/`, `services/`
+- 🗃️ **Database support** - SQLite, MySQL, or PostgreSQL
+- 🔧 **ORM of your choice** - SQLAlchemy or SQLModel
+- 🧪 **Testing setup** - pytest / pytest-asyncio with httpx, ready to go
+- 🧹 **Linter config** - Black or Ruff
+- 🐳 **Docker ready** - optional `Dockerfile` & `docker-compose.yml`
+- ⚙️ **Environment config** - pydantic-settings with `.env` support
+- 📖 **Documentation** - every folder gets a README explaining its purpose
+
+---
+
+## 📦 Installation
+
+### Install from PyPI
+
+```bash
+pip install fastapi-initializer
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv pip install fastapi-initializer
+```
+
+### Install from Source (for development)
+
+```bash
+# Clone the repository
+git clone https://github.com/DasunNethsara-04/fastapi-initializer.git
+cd fastapi-initializer
+
+# Create a virtual environment and install dependencies
+uv sync
+
+# Run the CLI directly
+uv run fastapi-init my-project
+```
+
+---
+
+## 🚀 Usage
+
+```bash
+fastapi-init my-project
+```
+
+You'll be guided through interactive prompts:
+
+```
+❯ FastAPI Initializer
+Creating project: my-project
+
+❯ What kind of database do you want to use?
+  > SQLite / MySQL / PostgreSQL / None
+
+❯ Which ORM do you want to use?
+  > SQLAlchemy / SQLModel / None
+
+❯ What linter do you want to use?
+  > Ruff / Black / None
+
+❯ What testing framework do you like to use?
+  > PyTest / pytest-async-io / None
+
+❯ Do you want to create a Docker file for this project?
+  > Yes / No
+
+✔ FastAPI project 'my-project' created successfully!
+```
+
+Then get started in seconds:
+
+```bash
+cd my-project
+uv sync
+uv run uvicorn app.main:app --reload
+```
+
+Open **http://127.0.0.1:8000/docs** to see the interactive API docs.
+
+---
+
+## 📁 Generated Project Structure
+
+The generated project follows a modular, production-style layout:
+
+```
+my-project/
+├── app/
+│   ├── api/
+│   │   ├── v1/
+│   │   │   └── users.py            # User endpoints
+│   │   ├── __init__.py              # Mounts versioned routers
+│   │   └── deps.py                  # Shared dependencies (e.g. auth)
+│   ├── core/
+│   │   ├── config.py                # App settings via pydantic-settings
+│   │   └── security.py              # OAuth2 / auth utilities
+│   ├── models/
+│   │   └── user.py                  # ORM model (SQLAlchemy / SQLModel)
+│   ├── schemas/
+│   │   └── user.py                  # Pydantic request / response models
+│   ├── services/
+│   │   └── user_service.py          # Business logic layer
+│   ├── db/
+│   │   ├── base.py                  # ORM Base class
+│   │   └── session.py               # Engine & get_session() dependency
+│   └── main.py                      # FastAPI app entry-point
+├── tests/
+│   └── test_users.py                # Smoke test with httpx
+├── .env                             # Environment variables
+├── .gitignore
+├── pyproject.toml
+├── Dockerfile                       # (optional)
+├── docker-compose.yml               # (optional)
+└── README.md                        # Auto-generated project docs
+```
+
+> **Note:** Folders like `models/`, `db/`, `tests/`, and Docker files are only generated when you select the corresponding options.
+
+### What Each Folder Does
+
+| Folder | Purpose |
+|--------|---------|
+| `app/api/` | HTTP route definitions, versioned (`v1/`, `v2/`, …). |
+| `app/core/` | App-wide settings (`Settings` class) and security helpers. |
+| `app/models/` | ORM model classes mapped to database tables. |
+| `app/schemas/` | Pydantic models for request validation and response serialisation. |
+| `app/services/` | Business-logic layer — keeps route handlers thin and testable. |
+| `app/db/` | Database engine, session factory, and `get_session()` dependency. |
+| `tests/` | Automated test suite using pytest + httpx. |
+
+---
+
+## 🛠️ Configuration Options
+
+| Prompt | Choices | What It Generates |
+|--------|---------|-------------------|
+| **Database** | SQLite, MySQL, PostgreSQL, None | `app/db/session.py` with connection URL and driver dependency |
+| **ORM** | SQLAlchemy, SQLModel, None | `app/models/` with model classes and `app/db/base.py` |
+| **Linter** | Ruff, Black, None | Adds the linter to `pyproject.toml` dependencies |
+| **Test framework** | pytest, pytest-asyncio, None | `tests/` directory with async smoke test |
+| **Docker** | Yes, No | `Dockerfile`, `docker-compose.yml`, `.dockerignore` |
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome! Here's how to get started:
+
+```bash
+# 1. Fork and clone
+git clone https://github.com/DasunNethsara-04/fastapi-initializer.git
+cd fastapi-initializer
+
+# 2. Install dependencies
+uv sync
+
+# 3. Make your changes, then test
+uv run fastapi-init test-project
+
+# 4. Submit a pull request
+```
+
+---
+
+## 📄 License
+
+This project is licensed under the [MIT License](LICENSE).
+
+---
+
+## 🙏 Acknowledgements
+
+Built with:
+
+- [FastAPI](https://fastapi.tiangolo.com/) — the framework this tool scaffolds
+- [Typer](https://typer.tiangolo.com/) — CLI framework
+- [InquirerPy](https://inquirerpy.readthedocs.io/) — interactive prompts