CouncilDataProject / CouncilDataProject/cdp-backend
Dynamically Generate TypeScript DB Models, Transcript Model, and other Constants
- Lingua principale
- Python
- Stelle
- 25
- Fork
- 28
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
## Idea / Feature
Dynamically generate TypeScript object definitions from `cdp-backend` Python DB models.
## Use Case / User Story
As a developer I want to be able to add, remove, or update a database model in a single location rather than multiple.
## Solution
Add a script to `cdp-backend` that when ran will generate a TypeScript package of the database models + extras that we can push to npm on new version push.
## Alternatives
## Stakeholders
Backend maintainers
Frontend maintainers
## Major Components
* [ ] Database models TypeScript generation
* [ ] Transcript File Model TypeScript generation
* [ ] Database "ModelField" Python and TypeScript generation
* [ ] Database constants TypeScript generation
* [ ] script added as bin script to `cdp-backend`
* [ ] task added to CI building and testing that attempts to generate these models on PR push / main build
* [ ] task added to CI main building / publish job that pushes the generated TypeScript package dir to npm
## Dependencies
## Other Notes
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
No specific files or tests are named. Start by locating the Python database models, the cdp-backend bin-script entry points, and the CI build and publish jobs; done means generated TypeScript models and constants are tested on builds and the package is published as specified.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python, typescript
- Ambito
- backend, build-system, ci-cd, databases, release
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 25/100