Skip to content

API Reference

This section is generated directly from the docstrings in src/zeython/ -- if it disagrees with the narrative docs elsewhere in this site, the narrative docs are describing intent and usage, and this reference is describing the actual current signatures. When in doubt, trust this section (or better, the source).

It's organized the same way the framework itself is, roughly matching the "Digging Deeper" grouping in the nav:

  • 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.