Skip to content
Orionis Framework

Orionis foundations

Build your application with the tools in Orionis. Choose what you need to develop and start with its guide.

Web and APIs Routes, controllers, middleware and HTTP responses. Realtime and WebSockets Hubs, typed calls, streaming and groups. MCP servers Tools, resources and prompts over HTTP or STDIO. Database and ORM Models, relationships, queries and migrations. Authentication and permissions Sessions, API tokens, roles and policies. Queues and jobs Worker execution with retries and failure handling. Files and cloud storage Uploads and local, S3, Azure or GCS disks. Views and templates HTML with Jinja2, layouts and helpers.

Also included mailcache and locksvalidationtestingtranslations.

Build your application from the official skeleton, then add the features your project needs. You do not need to implement Application, a kernel, or a container to start developing: the generated bootstrap/app.py connects those components.

Your first development session

Section titled “Your first development session”
  1. Install and create a project: prepare uv and Git, choose Blank or SSR, and create the application’s environment.
  2. Start the application: run the server from the project root and check the welcome page.
  3. Configure the application: use .env for deployment values and config/ for typed settings.
  4. Add your first HTTP route, then choose templates or a JSON API.
  5. Write and run a test before adding persistence, authentication, background jobs, Realtime, or MCP.

Commands in the application guides use uv run python -B reactor ... from the generated project root. This selects that project’s environment. The separate uvx --from orionis-installer ... invocation creates a new project.

Overview

Section titled “Overview”

Application extends the dependency-injection Container and is the object exported from orionis. It is simultaneously the bootstrap coordinator, ASGI/RSGI entry point, CLI dispatcher, configuration repository, path registry, provider loader, and lifecycle owner.

Foundation also defines frozen configuration entities for every major subsystem, immutable core metadata, the Directory path service, runtime/lifespan enums, and startup/shutdown presentation. Most applications configure it in bootstrap/app.py, call create(), and let the HTTP server or Reactor drive runtime startup.

Requirements

Section titled “Requirements”
  • Python 3.14 or newer; construction rejects older interpreters.
  • An application root represented by str or pathlib.Path.
  • Valid frozen dataclass configuration modules under the configured config path.
  • Route files that exist and import their required facade when registered.
  • One event loop per application worker; mutable runtime state is not designed for cross-loop or cross-thread sharing.

Module learning path

Section titled “Module learning path”

Continue with: environment · container · http · console.