Skip to main content

FastAPI app scaffolder with health, modules, and Postgres

Project description

fastapi_kick

A simple FastAPI project scaffolder. After installation, run fastapi_kick start <project_name> to generate a ready-to-run FastAPI app with:

  • main.py including CORS and router inclusion
  • Versioned API with /health endpoint
  • modules/example with basic router, schema, service, and model stub
  • Postgres configuration with sync and async SQLAlchemy sessions loaded from .env

Install

pip install fastapi_kick

On macOS with externally managed Python:

python3 -m pip install fastapi_kick --user --break-system-packages
export PATH="$(python3 -m site --user-base)/bin:$PATH"

Usage

fastapi_kick start my_project
cd my_project
uvicorn main:app --reload

Create .env in the project root:

DATABASE_URL_SYNC=postgresql://user:password@localhost:5432/db
DATABASE_URL_ASYNC=postgresql+asyncpg://user:password@localhost:5432/db

Development

pip install -r requirements.txt
python3 -m pip install -e .
fastapi_kick start dev_project

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fastapi_kick-0.1.1.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fastapi_kick-0.1.1-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file fastapi_kick-0.1.1.tar.gz.

File metadata

  • Download URL: fastapi_kick-0.1.1.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for fastapi_kick-0.1.1.tar.gz
Algorithm Hash digest
SHA256 46093b2038dcb26d1bb5949190ddd387c0014e8df4bb2d2442d1889476bf9f52
MD5 a0c4c791f117d2e2a6f7a17fe77dfecc
BLAKE2b-256 b8aa6dbc15fd02256bce86cd3dce8defbacd71e96e353c7e26a357b47bcdb34c

See more details on using hashes here.

File details

Details for the file fastapi_kick-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: fastapi_kick-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 7.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for fastapi_kick-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4ceb33f3749a0e4e69d923bf4cc8af7e3d990cefd016c28b57079c6195516a86
MD5 a832f166c12234b5f948ef6dadc3b0c2
BLAKE2b-256 3ae98449bca070fca55a28a6a6fc0ae74901422f1e929db624bc2fa28498da4f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page