Skip to main content

Generate remote-controlled-view path module scaffolds from SQLAlchemy-backed ExDataset metadata.

Project description

exdrf-gen-al2rcv

The remote-controlled-view (RCV) stack renders exdrf resources and companion data into UI shapes the SPA requests from the API.

exdrf-gen-al2rcv is an exdrf-gen plugin that emits FastAPI-oriented backend modules: a root api.py, per-resource {res_snake}_rcv_paths.py files under the category tree, and exdrf-rcv-compatible plans derived from SQLAlchemy models.

We generate a plan for each resource type based on the information extracted from SQLAlchemy database models.

Emitted layout includes a root __init__.py (imports api) and root api.py (scaffold), one {res_snake}_rcv_paths.py per resource under its category tree, and per-category __init__.py plus empty api.py.

Command-line usage

exdrf-gen al2rcv DATASET OUT-PATH --get-db MODULE:CALLABLE

Or: python -m exdrf_gen al2rcv ....

  • DATASETmodule.path:DeclarativeBase (same GetDataset convention as al2r).
  • OUT-PATH — output directory (or EXDRF_AL2RCV_PATH).
  • --get-db / EXDRF_AL2RCV_GET_DB — required dotted.module:callable for root api.py (same shape as al2r’s --get-db / EXDRF_AL2R_GET_DB).

Dependencies

exdrf-gen, exdrf-al, exdrf-rcv, click. Generated root api.py imports FastAPI and SQLAlchemy (add them in the host app).

Plugin registration

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

See also

  • exdrf-rcv — shared runtime imported by generated RCV modules.
  • exdrf-gen-al2r — FastAPI routers; same folder pattern for categories.
  • 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 Distribution

exdrf_gen_al2rcv-0.1.19.tar.gz (17.2 kB view details)

Uploaded Source

Built Distribution

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

exdrf_gen_al2rcv-0.1.19-py3-none-any.whl (19.7 kB view details)

Uploaded Python 3

File details

Details for the file exdrf_gen_al2rcv-0.1.19.tar.gz.

File metadata

  • Download URL: exdrf_gen_al2rcv-0.1.19.tar.gz
  • Upload date:
  • Size: 17.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for exdrf_gen_al2rcv-0.1.19.tar.gz
Algorithm Hash digest
SHA256 ee4bdedbd9b7d5763188174dc860aa9187a8139aac096fc36606596515246cb8
MD5 70aedb635eb6be71ad0d39a64294c849
BLAKE2b-256 b2084fd5b3427eda0a5eaf9006bd59b1be6d0e2eddff9139893ef3684bb3fea0

See more details on using hashes here.

File details

Details for the file exdrf_gen_al2rcv-0.1.19-py3-none-any.whl.

File metadata

File hashes

Hashes for exdrf_gen_al2rcv-0.1.19-py3-none-any.whl
Algorithm Hash digest
SHA256 98a49b1b0655095e52acd2684a667bd692d4837b176755d941af1a4db5623fbc
MD5 97e6c1f8fa43c0cc463f9405bb826f1d
BLAKE2b-256 6c76e882730e4640b21b33bf13cd8545273199e0233c0b41b9289658e9470596

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