poleposition 0.0.3

FastAPI project scaffolder for building clean and scalable APIs

PolePosition

A FastAPI project scaffolder for building enterprise-grade APIs.

Create a new FastAPI project in seconds:

poleposition startproject myapp

---

Why PolePosition?

Starting a FastAPI project should be fast, clean, and predictable.

PolePosition provides:

• A scalable project structure
• Environment-based configuration
• Built-in logging
• Testing setup
• A ready-to-run FastAPI application

No boilerplate. No setup friction.

---

Why not just FastAPI?

FastAPI is excellent, but starting a new project often involves:

• Recreating the same structure
• Setting up logging and configuration
• Organizing modules manually

PolePosition removes that overhead by providing a clean, production-ready starting point out of the box.

---

Installation

uv tool install poleposition

or

pip install poleposition

---

Quickstart

poleposition startproject myapp
cd myapp

# setup environment
cp .env.example .env

# install dependencies
uv sync

# run the app
uv run fastapi dev src/myapp/main.py

Open your API documentation at:

http://127.0.0.1:8000/docs

---

Project Structure

myapp/
├─ pyproject.toml
├─ .env.example
├─ src/
│  └─ myapp/
│     ├─ main.py
│     ├─ api/
│     │  └─ routes/
│     │     └─ status.py
│     └─ core/
│        ├─ config.py
│        └─ logging.py
└─ tests/

---

Status Endpoint

Check if your service is running:

GET /api/v1/status

{
  "status": "ok",
  "service": "myapp",
  "environment": "development",
  "version": "0.1.0"
}

---

Philosophy

PolePosition is built around a few principles:

• Minimal — no unnecessary abstractions
• Opinionated — sensible defaults
• Extensible — easy to grow into larger systems

The CLI is intentionally lightweight and avoids heavy templating engines.

---

Roadmap

• Project name validation
• poleposition add module
• JSON logging support
• Docker support
• Production-ready presets

---

Contributing

Contributions are welcome. Feel free to open an issue or submit a pull request.

---

License

MIT

Full license: https://github.com/erenertem/poleposition/blob/main/LICENSE