1.0 KiB
1.0 KiB
Developing in HV2 umbrella project
Tools and Templates
- venv for Python tools is used, remember to activate, install dependencies via
requirements.txt
, keep it up to date usingpip freeze > requirements.txt
- all tools provide should work on Linux and on Windows, shell scripts are avoided
- templates files must be generated at development time, generated files must be put into the repository
- use
generate.py
in the umbrella project's root without any arguments to generate all template files in all subdirectories using theschema.json
from the umbrella project's root
Subprojects
API
- to start the API set the required env variables (see
ENV.tmp
) or the configuration files in the subdirectory./config
and runtest.py
from the API subproject - make sure these configuration files are not added to the repository, they contain secrets
- in the development environment the API will answer at
http://localhost:8080
, the Swagger-UI is available athttp://localhost:8080/ui