API Reference

The public API documented below is accessible through fr, including submodules such as fr.views and fr.objects. Using fr. is the recommended convention:

import fastapi_restly as fr

Module reference

Module	Contents
fr	Names exported directly by the package, linked to their definitions in the submodules.
fr.views	View classes, route decorators, registration, CRUD methods, and action hooks.
fr.schemas	Pydantic bases, field markers, relationship references, and schema generation.
fr.models	SQLAlchemy declarative bases and mixins for IDs and timestamps.
fr.db	Configuration, session dependencies, session context managers, and engine access.
fr.clauses	Reusable query predicates, boolean composition, and request context values.
fr.query	The list params (filter, sort, and pagination) and how to apply them to SQLAlchemy queries.
fr.objects	Functions for building, updating, saving, and deleting ORM objects through a session.
fr.exc	Configuration errors, HTTP errors, and warnings.
fr.testing	Database test setup and synchronous and asynchronous test clients.
fr.utils	Shared settings instances through CurrentSettingsMixin.