General Coding Rules
This thread is used for overall guidance over the tool.
Order is important.
The first items are OpenAPI related and CSV.
- OpenAPI to model translation using OpenAPI Parser
- Input:
Yaml, JSON
- Link: LIVE Swagger UI ( 2nd iteration of the project)
- CSV ->
Model
- CSV ->
DataTables
- CSV ->
Charts
- CSV ->
Export
- Pandas DF ALL cases reuse the CSV code
3rd party Libs
Configuration
The configuration required by the tool should be managed as described below:
- loaded from
.env
- saved in CFG Class
- if possible, each variable will have a default value if not present in
.env
- In different parts of the tool, the variables from the Config class are used (not loaded from
.env file directly)
Model Translation rules:
- ID provided by default (integer, autoincremented)
- The types of fields should be detected using a simple guessing
- nothing fancy, we can iterate later over this
- Once the model is provided, the user can:
- specify the type for each column
- regenerate the model definition
Misc Rules
- No hard coding things like ports or file names
- Clean code
- Complex parts should have a minimal help
General Coding Rules
Order is important.
Yaml,JSONModelDataTablesChartsExport3rd party Libs
Configuration
The configuration required by the tool should be managed as described below:
.env.env.envfile directly)Model Translation rules:
Misc Rules