Package API#

fastapi_restly exports the following names directly as fr.<name>. Each link opens the symbol’s reference entry in its defining module. The module reference lists the submodules available through fr.

Name	Description
`fr.Action`	CRUD action names used by authorization and commit hooks.
`fr.all_of`	Combine query clauses with AND.
`fr.any_of`	Combine query clauses with OR.
`fr.apply_clauses`	Apply query clauses to a SQLAlchemy statement.
`fr.AsyncReactAdminView`	Async CRUD view for the react-admin simple REST protocol.
`fr.AsyncRestView`	CRUD view using an async SQLAlchemy session.
`fr.AsyncSessionDep`	FastAPI dependency annotation for an async session.
`fr.BaseSchema`	Pydantic base configured to read object attributes.
`fr.ClauseNamespace`	Group a model’s query clauses and default scope.
`fr.configure`	Configure database access and application integration.
`fr.ContextNamespace`	Declare and bind application context values.
`fr.ContextParam`	Declare one typed context value.
`fr.DataclassBase`	SQLAlchemy declarative base with dataclass constructors.
`fr.delete`	Decorate a DELETE endpoint method.
`fr.get`	Decorate a GET endpoint method.
`fr.IDBase`	Dataclass model base with an integer primary key.
`fr.IDRef`	Relationship reference serialized as a scalar ID.
`fr.IDSchema`	Schema base with a read-only ID, or a nested relationship reference when parameterized.
`fr.include_view`	Register a view’s endpoint methods on an app or router.
`fr.ListResult`	The objects, total count, and list params of a list, before response serialization.
`fr.MustExist`	Scalar foreign-key annotation that checks the referenced row exists.
`fr.none_of`	Negate a group of query clauses.
`fr.NoPagination`	Settings for a view’s `pagination` that returns every row, with a custom envelope.
`fr.NumberedPagination`	Page-number pagination settings for a view’s `pagination`.
`fr.open_async_session`	Open an async session outside request handling.
`fr.open_session`	Open a synchronous session outside request handling.
`fr.patch`	Decorate a PATCH endpoint method.
`fr.post`	Decorate a POST endpoint method.
`fr.put`	Decorate a PUT endpoint method.
`fr.ReactAdminView`	Synchronous CRUD view for the react-admin simple REST protocol.
`fr.ReadOnly`	Mark a field as excluded from generated create and update schemas.
`fr.RefExists`	Validate a reference against a model with an optional scope override.
`fr.resolve_scope`	Resolve the read scope for a view or model.
`fr.ResponseShape`	Response forms for one object, a list, or an empty body.
`fr.RestView`	CRUD view using a synchronous SQLAlchemy session.
`fr.route`	Decorate an endpoint method with explicit route options.
`fr.SessionDep`	FastAPI dependency annotation for a synchronous session.
`fr.TimestampsMixin`	Model fields for creation and update timestamps.
`fr.TimestampsSchemaMixin`	Read-only creation and update timestamps in a schema.
`fr.View`	Base class for a group of endpoint methods.
`fr.ViewRoute`	Default CRUD endpoint names for route exclusion.
`fr.where_clause`	Declare a reusable query predicate.
`fr.WhereClause`	A reusable predicate that produces a SQLAlchemy expression.
`fr.WriteOnly`	Mark a field as accepted on input and excluded from serialization.
`fr.__version__`	Installed package version.

fastapi_restly.__version__: str#: The installed fastapi-restly version, read from package metadata.