Skip to main content

TurboAPI - a high-performance ASGI framework with compiled routing, DI, validation, and OpenAPI.

Project description

py-turbo-api

TurboAPI is a small, fast ASGI web framework built from scratch (stdlib-only) with a focus on predictable performance.

Features

  • Trie router with {param} path params
  • APIRouter composition with prefixes/tags via include_router()
  • Compiled route plans (signature inspection happens at route registration, not per request)
  • Dependency injection with Depends() including nested and yield-based dependencies
  • Parameter source markers: Query, Header, Cookie, Form, File
  • Built-in validation with Model + field() (supports Annotated, Literal, Enum, datetime, UUID, Decimal)
  • Optional Pydantic v2 compatibility (request/response models + OpenAPI schema integration when installed)
  • Multipart/form-data parsing with UploadFile
  • Multipart hardening: per-file/part/field limits + upload spooling to disk
  • StreamingResponse, FileResponse, BackgroundTask, and static file mounting
  • Response primitives: RedirectResponse, NegotiatedResponse, cache header helpers, and EventSourceResponse for SSE
  • File hardening: ETag/If-None-Match + byte range (206/416) support
  • WebSocket route support via @app.websocket(...)
  • Sub-app mounting via app.mount("/prefix", sub_app) and host routing via app.mount_host("*.example.com", app)
  • WebSocket auth helpers (websocket_token_auth, websocket_jwt_auth) and OpenAPI WS extension docs (x-turbo-websockets)
  • Security primitives: api_key_auth(), bearer_auth(), jwt_auth(), OAuth2 password/auth-code/client-credentials helpers with OpenAPI security schemas
  • Session + CSRF protection primitives (SessionMiddleware, CSRFMiddleware, CSRF helpers)
  • Testing utilities: sync TestClient and async AsyncTestClient with WebSocket test sessions
  • OpenAPI at /openapi.json
  • Swagger UI at /docs and ReDoc at /redoc
  • Lifespan startup/shutdown handlers
  • Lifespan state resources with cleanup guarantees (app.add_state_resource(...))
  • App-state dependency helpers (app.state_dependency(...), app_state_dependency(...), get_app_state(...))
  • Custom exception handlers with @app.exception_handler(...)
  • Reliability defaults: request timeout, max body size, max concurrency
  • Runtime settings model (TurboSettings) + Turbo.from_env() for env-driven deploy config
  • Graceful shutdown request draining (shutdown_drain_timeout)
  • Background job primitives: InMemoryJobQueue with retries, delay/schedule, and idempotency keys
  • Queue adapters: CeleryQueueAdapter, RQQueueAdapter, RedisQueueAdapter
  • CI release gates: Python matrix tests/lint + package build and twine check, with trusted publishing workflow
  • Benchmark suite + perf regression gates in CI (benchmarks/bench_runtime.py)

Stability

  • Compatibility policy: API_COMPATIBILITY.md
  • Current status: pre-1.0 (public API is stabilizing toward v1.0.0)

Install

From PyPI

pip install py-turbo-api

Optional: Pydantic v2 compatibility

pip install "py-turbo-api[pydantic]"

PyPI: https://pypi.org/project/py-turbo-api/

Run example

uvicorn app:app --reload

Open:

Documentation Tracks

  • Docs home (GitHub Pages entry): docs/index.md
  • Complete API reference: docs/api-reference.md
  • Tutorial: docs/tutorial.md
  • Advanced: docs/advanced.md
  • Deployment: docs/deployment.md
  • Security recipes: docs/security-recipes.md
  • Why TurboAPI + benchmark method: docs/why-turboapi.md

Benchmarks

python benchmarks/bench_runtime.py --baseline benchmarks/baseline.json --tolerance 1.20 --gate

License

Apache-2.0 (see LICENSE).

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

py_turbo_api-1.0.3.tar.gz (87.2 kB view details)

Uploaded Source

Built Distribution

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

py_turbo_api-1.0.3-py3-none-any.whl (73.1 kB view details)

Uploaded Python 3

File details

Details for the file py_turbo_api-1.0.3.tar.gz.

File metadata

  • Download URL: py_turbo_api-1.0.3.tar.gz
  • Upload date:
  • Size: 87.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for py_turbo_api-1.0.3.tar.gz
Algorithm Hash digest
SHA256 5c6a8847dd6aeb7c61662a666912c61caa5408bb09a35703c5f8486263fb08eb
MD5 58474a702966e66a38528b34550022c0
BLAKE2b-256 0c53d8554dd35202f83f1fa96bfbb096679a4beeabce1dd7b949416c6e4fd5b4

See more details on using hashes here.

Provenance

The following attestation bundles were made for py_turbo_api-1.0.3.tar.gz:

Publisher: publish.yml on pareshpanat/turboapi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file py_turbo_api-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: py_turbo_api-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 73.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for py_turbo_api-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8ec8d3adcf3959471e49eb6a592744c2af92be97b375a4fbefd571dbe8216350
MD5 3fec92505596b5b7f7d01dee0bdc9a61
BLAKE2b-256 1704972b7f2fd144cd1b713186c5b52e19c1681740b0c6e30269752d0432f8ec

See more details on using hashes here.

Provenance

The following attestation bundles were made for py_turbo_api-1.0.3-py3-none-any.whl:

Publisher: publish.yml on pareshpanat/turboapi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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