Skip to main content

Generate FastAPI route modules from SQLAlchemy-backed ExDataset metadata.

Project description

exdrf-gen-al2r

exdrf-gen-al2r is an exdrf-gen plugin that emits FastAPI APIRouter stubs from SQLAlchemy-backed ExDataset metadata. List and read handlers are typed with XxxEx; create uses XxxCreate. Patch is emitted only when exdrf-gen-al2pd would emit XxxEdit (composite PK–only link tables skip PATCH).

Python 3.12.2+ is required.

Command-line usage

exdrf-gen al2r DATASET OUT-PATH DB-MODULE SCHEMAS-PKG

Or: python -m exdrf_gen al2r ....

  • DATASETmodule.path:DeclarativeBase.
  • OUT-PATH — directory for *_routes.py and __init__.py (or EXDRF_AL2R_PATH).
  • DB-MODULE — dotted import path for ORM classes (from DB-MODULE import Model).
  • SCHEMAS-PKG — dotted root package where al2pd wrote schemas (or EXDRF_AL2R_SCHEMAS). Import path per resource is SCHEMAS-PKG.<categories...>.<snake_case_name_plural> (e.g. myapp.schemas.widgets for Widget at the root category).

Path parameters for GET/PATCH follow resource.primary_fields() order (e.g. {left_id}/{right_id} for composite keys).

Dependencies

exdrf-gen, exdrf-al, click, exdrf-gen-al2pd (for resource_generates_edit_payload). Generated routers import FastAPI and SQLAlchemy — add those to the application environment.

Plugin registration

[project.entry-points.'exdrf.plugins']
exdrf_gen = 'exdrf_gen_al2r'

See also

  • exdrf-gen-al2pd — generates the Pydantic modules al2r imports.
  • exdrf-genREADME.md.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

exdrf_gen_al2r-0.1.11-py3-none-any.whl (29.6 kB view details)

Uploaded Python 3

File details

Details for the file exdrf_gen_al2r-0.1.11-py3-none-any.whl.

File metadata

File hashes

Hashes for exdrf_gen_al2r-0.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 820ec9e0a279dbd9cd344e4f6295739ce1f2cf5f65151b4b4435b43f7abe510c
MD5 e3050702201a0e1f290d97b042a5f108
BLAKE2b-256 6f2438a40e68c9cb5ec0d1b95cf1834c0ea6abc340ccf80a8219faf32eda3955

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page