Skip to content

API Reference

This reference is generated directly from the docstrings in src/zeython/, so it always reflects the exact signatures of the current release. The narrative guides explain intent and usage; this section is the authoritative record of what each class and function accepts and returns.

It is organized the way the framework itself is:

  • Core


    Application, Container, Config, service providers, Router/Controller, Views, exceptions, validation.

    Reference

  • Database


    Model, Database, Page, transactions, N+1 detection, factories & seeders.

    Reference

  • Security


    Session auth, API token auth, RBAC authorization, CSRF, security headers, password hashing, multi-tenancy.

    Reference

  • HTTP & APIs


    Rate limiting, ETags, gzip, request IDs, OpenAPI generation.

    Reference

  • Jobs & Realtime


    Queues, the scheduler, WebSockets, mail.

    Reference

  • Operations


    Health checks, logging, error monitoring, caching, storage.

    Reference

  • Extensibility


    Console commands, the plugin registry, localization, the admin panel, AI integration.

    Reference

Most of these classes and functions are also re-exported from the top-level zeython package, so from zeython import Application and from zeython.application import Application reach the same object — import from whichever is clearer at the call site.