enterpipelite 1.0.0a2

Decorator-first FastAPI toolkit for REST endpoints with normalized responses and plugin-ready integrations.

EnterPipeLite

EnterPipeLite is a typed, decorator-first toolkit for building REST APIs on FastAPI. It provides OpenAPI generation, normalized response envelopes, validation, named authentication and rate limiting, and plugin-shaped database, HTTP, Redis, Kafka, cache, and observability integrations.

Alpha prerelease: 1.0.0a2 is intended for evaluation. Public APIs may still evolve before stable 1.0.0 according to the documented deprecation policy.

راهنمای فارسی · Repository · Issues

Installation

Install the prerelease from PyPI after it is published:

python -m pip install --pre enterpipelite

Optional integrations are installed through extras:

python -m pip install --pre "enterpipelite[server]"
python -m pip install --pre "enterpipelite[security]"
python -m pip install --pre "enterpipelite[redis]"
python -m pip install --pre "enterpipelite[kafka]"
python -m pip install --pre "enterpipelite[postgres]"
python -m pip install --pre "enterpipelite[mysql]"
python -m pip install --pre "enterpipelite[mssql]"

Supported Python versions: 3.11 through 3.14.

Minimal app

from enterpipelite import EnterPipeApp, get
from enterpipelite.core.registry import EndpointRegistry
from enterpipelite.resources import ResourceRegistry
from enterpipelite.security import SecurityRegistry

registry = EndpointRegistry()

@get("/hello", registry=registry)
async def hello(name: str = "world"):
    return {"message": f"Hello {name}"}

app = EnterPipeApp(
    registry=registry,
    resource_registry=ResourceRegistry(),
    security_registry=SecurityRegistry(),
    auto_configure_resources=False,
    auto_configure_security=False,
).build()

Run it from a source checkout:

python -m uvicorn examples.basic_app:app --reload --env-file .env

Open /docs for Swagger UI and /openapi.json for the generated schema. JSON responses use a consistent envelope containing success, status_code, data, error, and execution metadata.

Features

• Concise @get, @post, @put, @patch, @delete, and @ep endpoint declarations.
• Accurate OpenAPI for signatures, decorator-declared bodies, security, and rate-limit metadata.
• Handler, declarative operation, and hybrid endpoint modes.
• PostgreSQL, MySQL, SQL Server, outbound HTTP, Redis, Kafka, cache, and Sentry providers.
• Named API-key, JWT, OIDC resource-server, and external authentication providers.
• Multiple named provider instances, with at most one auth provider selected per endpoint.
• Versioned HMAC API-key digests, consumer credentials, rotation, and revocation.
• In-memory and Redis fixed-window rate limiting.
• Stable typed contracts for external resource and authentication plugins.

Security model

Secrets and concrete credentials belong in environment variables. Source and JSON configuration reference environment-variable names through fields such as dsn_env, url_env, api_key_env, pepper_env, and verification_key_env. API-key consumer stores retain versioned HMAC digests, not plaintext keys. OIDC support validates bearer access tokens as a resource server; it does not implement browser login or authorization-code flows.

Generate an API-key digest without putting the key on the command line:

python -m enterpipelite.security hash-api-key --pepper-env ENTERPIPE_API_KEY_PEPPER

See SECURITY.md before reporting a vulnerability.

Documentation

English:

• Quickstart
• Concepts
• Security
• API keys and rotation
• JWT and OIDC
• Rate limiting
• Resources and plugins
• Release and compatibility policy
• Docker and Kubernetes deployment

Persian / فارسی:

• شروع سریع
• مفاهیم
• امنیت
• API key و rotation
• JWT و OIDC
• محدودسازی نرخ
• Resourceها و pluginها
• سیاست انتشار و سازگاری
• استقرار Docker و Kubernetes

External plugin starters are available in templates/resource_provider and templates/auth_provider.

Development

python -m pip install -e ".[dev,all]"
python -m ruff check .
python -m ruff format --check .
python -m mypy enterpipelite
python -m pytest --ignore=tests/integration
python -m build

Integration tests require explicitly configured disposable services. Never point them at shared or production databases.

Project policy

• Changelog
• Contributing
• Support
• Code of Conduct
• Security Policy
• MIT License

Canonical project links: repository, issue tracker, and changelog.