pyferox 0.0.2

Transport-agnostic, async-first modular service application framework.

PyFerOx

Transport-agnostic, async-first Python service framework built around:

• typed command/query/event contracts
• modular composition
• execution middleware + lifecycle hooks
• pluggable transports (HTTP, jobs/worker, RPC, scheduler)

Project Status

Phase 1-3 implementation is complete according to repository audits:

• Phase 1 audit
• Phase 2 audit
• Phase 3 audit

Documentation

Full user docs are in docs/.

Recommended start:

1. Quickstart
2. Core Concepts
3. HTTP, Auth, OpenAPI
4. Persistence (SQLAlchemy)
5. Background and Distributed Runtime
6. Testing
7. Configuration
8. CLI Reference
9. Operations and Tuning

Install

pip install -e ".[dev,http]"

Minimal Example

from pyferox import App, HTTPAdapter, Module, StructCommand, StructQuery, handle, singleton


class UserRepo:
    async def create(self, email: str, name: str) -> int:
        return 1

    async def get(self, user_id: int) -> dict[str, str]:
        return {"id": str(user_id), "email": "[e-mail]", "name": "User"}


class CreateUser(StructCommand):
    email: str
    name: str


class GetUser(StructQuery):
    user_id: int


@handle(CreateUser)
async def create_user(cmd: CreateUser, users: UserRepo) -> dict[str, int]:
    return {"id": await users.create(cmd.email, cmd.name)}


@handle(GetUser)
async def get_user(query: GetUser, users: UserRepo) -> dict[str, str]:
    return await users.get(query.user_id)


app = App(modules=[Module(handlers=[create_user, get_user], providers=[singleton(UserRepo())])])
http = HTTPAdapter(app)
http.command("POST", "/users", CreateUser, status_code=201)
http.query("GET", "/users/{user_id}", GetUser)

PyFerOx is msgspec-backed. For new transport-facing contracts, prefer StructCommand / StructQuery / StructEvent. Dataclass contracts are still supported, but they are not the primary style to teach in user-facing examples.

Run:

uvicorn app.main:http --reload

Or scaffold first:

pyferox create-project demo_service --template api
cd demo_service
pyferox run-dev --target app.main:http