fastapi-auth-starter 0.1.3__py3-none-any.whl

fastapi_auth_starter-0.1.3.data/data/pyproject.toml

@@ -0,0 +1,77 @@
+[project]
+name = "fastapi-auth-starter"
+version = "0.1.3"
+description = "A clean architecture FastAPI starter template with authentication, PostgreSQL, and Alembic migrations"
+readme = "README.md"
+# Vercel supports up to Python 3.12
+requires-python = ">=3.12"
+# PyPI metadata - update with your information
+authors = [
+    {name = "Godswill William", email = "godswill.wilz@gmail.com"},
+]
+license = {text = "MIT"}
+keywords = ["fastapi", "starter", "template", "authentication", "postgresql", "alembic"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Framework :: FastAPI",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Internet :: WWW/HTTP :: HTTP Servers",
+]
+dependencies = [
+    "asyncpg>=0.30.0",
+    "authlib>=1.6.5",
+    "fastapi>=0.121.0",
+    "greenlet>=3.2.4",
+    "httpx>=0.28.1",
+    "pydantic>=2.0.0",
+    "pydantic-settings>=2.11.0",
+    "sqlalchemy>=2.0.44",
+    "uvicorn[standard]>=0.38.0",
+    "workos>=5.0.0",
+]
+# Project URLs - update with your repository
+[project.urls]
+Homepage = "https://github.com/splenwilz/fastapi-auth-starter"
+Documentation = "https://github.com/splenwilz/fastapi-auth-starter#readme"
+Repository = "https://github.com/splenwilz/fastapi-auth-starter"
+Issues = "https://github.com/splenwilz/fastapi-auth-starter/issues"
+# CLI entry point for scaffolding new projects
+# Usage: fastapi-auth-starter init <project-name>
+[project.scripts]
+fastapi-auth-starter = "fastapi_auth_starter.cli:main"
+
+# Development dependencies (not needed for runtime on Vercel)
+# These are only needed for local development and migrations
+[project.optional-dependencies]
+dev = [
+    "alembic>=1.17.1",
+    "psycopg2-binary>=2.9.11",
+]
+
+# Build system configuration
+# Reference: https://peps.python.org/pep-0517/
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+# Package data configuration
+# Include template files when installing as a package
+# Reference: https://hatch.pypa.io/latest/config/build/#shared-data
+[tool.hatch.build.targets.wheel]
+packages = ["fastapi_auth_starter"]
+
+# Include template files as package data
+# These will be accessible via the package installation
+[tool.hatch.build.targets.wheel.shared-data]
+"app" = "app"
+"alembic" = "alembic"
+"alembic.ini" = "alembic.ini"
+"pyproject.toml" = "pyproject.toml"
+"README.md" = "README.md"
+"runtime.txt" = "runtime.txt"
+"vercel.json" = "vercel.json"

fastapi_auth_starter-0.1.3.data/data/runtime.txt

@@ -0,0 +1,2 @@
+python-3.12
+

fastapi_auth_starter-0.1.3.data/data/vercel.json

@@ -0,0 +1,19 @@
+{
+  "version": 2,
+  "builds": [
+    {
+      "src": "app/main.py",
+      "use": "@vercel/python"
+    }
+  ],
+  "routes": [
+    {
+      "src": "/(.*)",
+      "dest": "app/main.py"
+    }
+  ],
+  "env": {
+    "PYTHON_VERSION": "3.12"
+  }
+}
+

fastapi_auth_starter-0.1.3.dist-info/METADATA

@@ -0,0 +1,283 @@
+Metadata-Version: 2.4
+Name: fastapi-auth-starter
+Version: 0.1.3
+Summary: A clean architecture FastAPI starter template with authentication, PostgreSQL, and Alembic migrations
+Project-URL: Homepage, https://github.com/splenwilz/fastapi-auth-starter
+Project-URL: Documentation, https://github.com/splenwilz/fastapi-auth-starter#readme
+Project-URL: Repository, https://github.com/splenwilz/fastapi-auth-starter
+Project-URL: Issues, https://github.com/splenwilz/fastapi-auth-starter/issues
+Author-email: Godswill William <godswill.wilz@gmail.com>
+License: MIT
+Keywords: alembic,authentication,fastapi,postgresql,starter,template
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Requires-Dist: asyncpg>=0.30.0
+Requires-Dist: authlib>=1.6.5
+Requires-Dist: fastapi>=0.121.0
+Requires-Dist: greenlet>=3.2.4
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pydantic-settings>=2.11.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: sqlalchemy>=2.0.44
+Requires-Dist: uvicorn[standard]>=0.38.0
+Requires-Dist: workos>=5.0.0
+Provides-Extra: dev
+Requires-Dist: alembic>=1.17.1; extra == 'dev'
+Requires-Dist: psycopg2-binary>=2.9.11; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# FastAPI Auth Starter
+
+A clean architecture FastAPI project starter with PostgreSQL and Alembic migrations.
+
+## Project Structure
+
+```
+fastapi_auth_starter/
+├── app/
+│   ├── __init__.py
+│   ├── main.py              # FastAPI application entry point
+│   ├── api/
+│   │   └── v1/
+│   │       ├── api.py       # API router aggregation
+│   │       └── routes/
+│   │           └── health.py  # Health check endpoint
+│   ├── core/
+│   │   ├── config.py        # Application configuration
+│   │   └── database.py      # Database connection and session management
+│   ├── models/              # SQLAlchemy database models
+│   ├── services/            # Business logic services
+│   └── db/                  # Database utilities
+├── alembic/                 # Database migration scripts
+├── alembic.ini              # Alembic configuration
+├── pyproject.toml           # Project dependencies (uv)
+└── README.md
+```
+
+## Features
+
+- ✅ Clean architecture with separation of concerns
+- ✅ FastAPI with async SQLAlchemy
+- ✅ PostgreSQL database support
+- ✅ Alembic for database migrations
+- ✅ Health check endpoint
+- ✅ Dependency injection with FastAPI
+- ✅ Environment-based configuration
+
+## Prerequisites
+
+- Python 3.12+ (3.13 for local dev, 3.12 for Vercel deployment)
+- [uv](https://github.com/astral-sh/uv) package manager
+- PostgreSQL database (local or remote)
+
+## Setup
+
+### 1. Install Dependencies
+
+Dependencies are managed with `uv`. They are automatically installed when you run commands with `uv run`.
+
+### 2. Configure Environment Variables
+
+**Important:** Copy the example environment file and configure your settings:
+
+```bash
+cp .env.example .env
+```
+
+Then edit `.env` with your configuration:
+
+```bash
+# Database Configuration
+DATABASE_URL=postgresql+asyncpg://user:password@localhost:5432/fastapi_auth
+
+# API Configuration (optional - defaults are fine)
+API_V1_PREFIX=/api/v1
+PROJECT_NAME=FastAPI Auth Starter
+VERSION=0.1.0
+```
+
+**Note:** 
+- The `.env` file is gitignored and should not be committed
+- The application uses `asyncpg` for async operations, but Alembic uses `psycopg2` for migrations (sync driver)
+- All sensitive configuration should be in `.env` file, not hardcoded
+
+### 3. Initialize Database
+
+First, ensure PostgreSQL is running and create the database:
+
+```bash
+createdb fastapi_auth
+```
+
+Or using PostgreSQL client:
+
+```sql
+CREATE DATABASE fastapi_auth;
+```
+
+### 4. Run Migrations
+
+```bash
+# Create initial migration (if needed)
+uv run alembic revision --autogenerate -m "Initial migration"
+
+# Apply migrations
+uv run alembic upgrade head
+```
+
+## Running the Application
+
+### Development Server
+
+```bash
+uv run uvicorn app.main:app --reload
+```
+
+The API will be available at:
+- API: http://localhost:8000
+- Docs: http://localhost:8000/docs
+- ReDoc: http://localhost:8000/redoc
+
+### Health Check
+
+Test the health endpoint:
+
+```bash
+curl http://localhost:8000/api/v1/health
+```
+
+Expected response:
+```json
+{
+  "status": "healthy",
+  "message": "Service is running"
+}
+```
+
+## Development
+
+### Adding New Routes
+
+1. Create a new route file in `app/api/v1/routes/`
+2. Import and include the router in `app/api/v1/api.py`
+
+Example:
+```python
+# app/api/v1/routes/users.py
+from fastapi import APIRouter
+
+router = APIRouter(prefix="/users", tags=["users"])
+
+@router.get("/")
+async def get_users():
+    return {"users": []}
+```
+
+Then add to `app/api/v1/api.py`:
+```python
+from app.api.v1.routes import users
+api_router.include_router(users.router)
+```
+
+### Adding Database Models
+
+1. Create model in `app/models/`
+2. Import in `app/models/__init__.py`
+3. Import in `alembic/env.py` (for autogenerate)
+
+Example:
+```python
+# app/models/user.py
+from sqlalchemy import Column, Integer, String
+from app.core.database import Base
+
+class User(Base):
+    __tablename__ = "users"
+    
+    id = Column(Integer, primary_key=True)
+    email = Column(String, unique=True, index=True)
+```
+
+### Creating Migrations
+
+```bash
+# Auto-generate migration from model changes
+uv run alembic revision --autogenerate -m "Description of changes"
+
+# Create empty migration
+uv run alembic revision -m "Description of changes"
+```
+
+### Applying Migrations
+
+```bash
+# Apply all pending migrations
+uv run alembic upgrade head
+
+# Rollback one migration
+uv run alembic downgrade -1
+
+# Rollback to specific revision
+uv run alembic downgrade <revision>
+```
+
+## Architecture
+
+### Layers
+
+- **API Layer** (`app/api/`): Route handlers, request/response models
+- **Service Layer** (`app/services/`): Business logic, domain operations
+- **Model Layer** (`app/models/`): SQLAlchemy database models
+- **Core Layer** (`app/core/`): Configuration, database setup, utilities
+
+### Dependency Injection
+
+FastAPI's dependency injection is used throughout:
+- Database sessions via `get_db()` dependency
+- Configuration via `settings` object
+- Custom dependencies in `app/core/dependencies.py` (create as needed)
+
+## Deployment
+
+### Vercel Deployment
+
+1. **Install Dev Dependencies Locally:**
+   ```bash
+   uv sync  # Installs all dependencies including dev
+   ```
+
+2. **Set Environment Variables in Vercel:**
+   - Go to your project settings in Vercel
+   - Add `DATABASE_URL` environment variable with your PostgreSQL connection string
+   - Format: `postgresql+asyncpg://user:password@host:port/database`
+
+3. **Deploy:**
+   ```bash
+   vercel --prod
+   ```
+
+**Note:** 
+- Runtime dependencies don't include `psycopg2-binary` or `alembic` (only needed for local migrations)
+- Python 3.12 is used (Vercel doesn't support 3.13 yet)
+- Make sure to run migrations on your database before deploying
+
+## References
+
+- [FastAPI Documentation](https://fastapi.tiangolo.com/)
+- [SQLAlchemy Async Documentation](https://docs.sqlalchemy.org/en/20/orm/extensions/asyncio.html)
+- [Alembic Documentation](https://alembic.sqlalchemy.org/)
+- [uv Documentation](https://github.com/astral-sh/uv)
+- [Vercel Python Documentation](https://vercel.com/docs/functions/serverless-functions/runtimes/python)
+
+## License
+
+MIT
+

fastapi_auth_starter-0.1.3.dist-info/RECORD

@@ -0,0 +1,44 @@
+fastapi_auth_starter/__init__.py,sha256=_oe3ygpaxfGsEg-v3CcZdcQEJce2NX8Ogn7BsXdRFFQ,117
+fastapi_auth_starter/cli.py,sha256=ejjdku4XxWfHGkRK6as4f9oxIcmMUHx6ILDzwNKv6HE,13047
+fastapi_auth_starter-0.1.3.data/data/README.md,sha256=J6iz6y-Hz5ypL_hUureMUTL12Y-Yxcr6FPFhIO8HbcM,6121
+fastapi_auth_starter-0.1.3.data/data/alembic/README,sha256=MVlc9TYmr57RbhXET6QxgyCcwWP7w-vLkEsirENqiIQ,38
+fastapi_auth_starter-0.1.3.data/data/alembic/env.py,sha256=kOr7q2b4fx9VsXnCvlDWsIgPzMRMh-Hsybsveo3mk_4,3368
+fastapi_auth_starter-0.1.3.data/data/alembic/script.py.mako,sha256=04kgeBtNMa4cCnG8CfQcKt6P6rnloIfj8wy0u_DBydM,704
+fastapi_auth_starter-0.1.3.data/data/alembic/versions/279c472f4fd8_add_user_table.py,sha256=hqKI3mU27Spz-ayeRmKKDQK1xG2kTqdY5TXdfyaAMJs,1407
+fastapi_auth_starter-0.1.3.data/data/alembic/versions/5f062b3648fa_change_user_id_from_uuid_to_string_for_.py,sha256=VxC5DiNuNQRMgsclrNVjLdu44DYHN0gGjmVD3lZxPCM,1075
+fastapi_auth_starter-0.1.3.data/data/alembic/versions/8d275132562b_create_tasks_table.py,sha256=mzxHNFHkBvaR9CWFIB8Jz7hMkIY12gwBvnpGQsvDNf0,1548
+fastapi_auth_starter-0.1.3.data/data/alembic.ini,sha256=NZUw5bwb1N8uElvXYq_38JdXRvJ8IX5p5KjxDmygFQE,5002
+fastapi_auth_starter-0.1.3.data/data/app/__init__.py,sha256=1hdk85waF_8t_8V7rOZyGxLOlx1DSIqJXsuNDZfHBcw,67
+fastapi_auth_starter-0.1.3.data/data/app/main.py,sha256=YxGowc7LDy3yCbyhYDMR9zVFRQoaOIgAtWqYKRiUJu4,2589
+fastapi_auth_starter-0.1.3.data/data/app/api/__init__.py,sha256=ptw7X8igNLTgUzcLgpKxcvpmpXdDAwS7sMDhIFxA10s,34
+fastapi_auth_starter-0.1.3.data/data/app/api/v1/__init__.py,sha256=ASsNzolUr1IstIwbO38MCNJ1Xs51V0DKWAS4DfiwKh8,23
+fastapi_auth_starter-0.1.3.data/data/app/api/v1/api.py,sha256=v9MKSftTFmYZcHOHW8HIk5U4G8GgplobSgB2B_GvnQg,641
+fastapi_auth_starter-0.1.3.data/data/app/api/v1/routes/__init__.py,sha256=dj0_ARCaRKEG74xN-RLe1XyAxyD34XzejIdeNxq7sGk,31
+fastapi_auth_starter-0.1.3.data/data/app/api/v1/routes/auth.py,sha256=guWqH4AIn1Cj0TAztD-DwE-Z56khTWrDbTsnbRZap_s,21198
+fastapi_auth_starter-0.1.3.data/data/app/api/v1/routes/health.py,sha256=K7eJ-ON0Fvdsljf0kPpA-zrbAt13P2sldQESeF4evKU,1304
+fastapi_auth_starter-0.1.3.data/data/app/api/v1/routes/task.py,sha256=kDRVwWXJqpTF63V2NTcV3Bxl5QdpPDNr04AP7UhmqDM,4613
+fastapi_auth_starter-0.1.3.data/data/app/api/v1/routes/user.py,sha256=ICd5JOLK1exBPG2u9atLATlcL-zDzmCmMpCe_KYJYwc,4241
+fastapi_auth_starter-0.1.3.data/data/app/api/v1/schemas/__init__.py,sha256=6XGfEtUUQImTmeXLWsd-fNa1tdJmwFxkGGhyBoK45ms,188
+fastapi_auth_starter-0.1.3.data/data/app/api/v1/schemas/auth.py,sha256=JaZfjCl1wJpB69u5cvUP4ADOD8-ZXm5Mx1wBQRuMC1Q,8395
+fastapi_auth_starter-0.1.3.data/data/app/api/v1/schemas/task.py,sha256=mmuUTw4IIb_fDVJPV4PX1IGc4WBtOszxd2J7NjSsjO0,2200
+fastapi_auth_starter-0.1.3.data/data/app/api/v1/schemas/user.py,sha256=MTR_a7o_oMCvYNSkU4g6cQc2Fh_rPb029yx3qgG30Gw,4212
+fastapi_auth_starter-0.1.3.data/data/app/core/__init__.py,sha256=4VnyQepM4vafTCgsrU2Yx5YjDD5iCsZe148g8bvlwh0,54
+fastapi_auth_starter-0.1.3.data/data/app/core/config.py,sha256=8yvriWsF7FWCuhZI97R2sJJLfTXjHoHEkajHurDejlM,4055
+fastapi_auth_starter-0.1.3.data/data/app/core/database.py,sha256=sXBnCQSwySpOfxCC7PF9FP-plGgH1bOpIkEcHXtz6sE,4392
+fastapi_auth_starter-0.1.3.data/data/app/core/dependencies.py,sha256=U7ekZ3ZzFqY__0nDlMGrlSRjY-kTPn0uI2P5jSa_P-Q,5554
+fastapi_auth_starter-0.1.3.data/data/app/core/exceptions.py,sha256=NyvRj0hgBPe4UQBTuN_T6n6h9jpDenWtYkHgqSpimL4,252
+fastapi_auth_starter-0.1.3.data/data/app/db/__init__.py,sha256=C6seBO0BKQ1nIOWXkEo2l-kzGTNDbPIAZ3OgBv2X_WA,40
+fastapi_auth_starter-0.1.3.data/data/app/models/__init__.py,sha256=BYi70T2uNqed6MshLHEQzlQjXq-lv3S9RmdCrQxVFtQ,344
+fastapi_auth_starter-0.1.3.data/data/app/models/task.py,sha256=SQCjssmEpxES6XGQH2jv3FuLQnpo3AXYMEdEj6dN1UA,2084
+fastapi_auth_starter-0.1.3.data/data/app/models/user.py,sha256=mA1xL_Mp9N3uaeEQRipEFPCrqudckg72hgn0OWCvxow,1899
+fastapi_auth_starter-0.1.3.data/data/app/services/__init__.py,sha256=jJnQMl8R2BRzLy0qlMAb1W9gqN4aPMWctFZ6UXaw3O8,147
+fastapi_auth_starter-0.1.3.data/data/app/services/auth.py,sha256=0dIt9Xevpvk5GA1jDcSrnLRTzjurj_Vi0OusIpVXJGc,17221
+fastapi_auth_starter-0.1.3.data/data/app/services/task.py,sha256=ue-qzZFwxhmeV6B0X3X7ogwK4c3r_rhkoAqp_7T60-c,5321
+fastapi_auth_starter-0.1.3.data/data/app/services/user.py,sha256=Vs2vguWAmfB_Don8visYDAez84sq0ThhK3KtxPsz4Yc,4293
+fastapi_auth_starter-0.1.3.data/data/pyproject.toml,sha256=hTM80R7ihIGVfFFSRongnjicyWkjk3D_KYsXtEug47o,2620
+fastapi_auth_starter-0.1.3.data/data/runtime.txt,sha256=PAbx-nAMyJmFpY8DnG5bSpc_xS4sULT7CSwPietTLzo,13
+fastapi_auth_starter-0.1.3.data/data/vercel.json,sha256=zWpTUtGSFo8m7mIWOGbiZSRKkRIwNh-31LKihMblAcQ,235
+fastapi_auth_starter-0.1.3.dist-info/METADATA,sha256=mumUaGb6Zzb4HfAO6gYtDmqHbUOMIaCZP5o2QkXPn8k,7714
+fastapi_auth_starter-0.1.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+fastapi_auth_starter-0.1.3.dist-info/entry_points.txt,sha256=os8s60iu3RRRA9TcyEcwWiLKTtK0w63zUMDyJ-yTU4U,71
+fastapi_auth_starter-0.1.3.dist-info/RECORD,,

fastapi_auth_starter-0.1.3.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

fastapi_auth_starter-0.1.3.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+fastapi-auth-starter = fastapi_auth_starter.cli:main