Archived

This repository has been archived on 2025-02-17. You can view files and clone it, but cannot push or open issues or pull requests.

History

Daniel Schick b254759562 fixed mixup in enum ids outgoing/shifting for shipcall queries		2023-10-28 12:43:36 +02:00
..
BreCal	fixed mixup in enum ids outgoing/shifting for shipcall queries	2023-10-28 12:43:36 +02:00
tests	correcting an import error for 'evaluate_shipcall_state', updating misc/Deployment to describe the creation of a virtual environment, Python installation and running tests (pytest and pytest-coverage).	2023-10-19 13:26:19 +02:00
flaskapp.wsgi	add missing include	2023-10-16 18:47:22 +02:00
README.md	updated environment	2023-03-12 11:56:24 +01:00
requirements.txt	Adding validation rules (traffic light status) to the system. Post & Put calls of shipcalls and times now execute the traffic light evaluation and store the result in the connected MySQL database instance. The 'brecal_utils' library is merged with 'BreCal', including the stub objects and test functions. Requirements were adapted, and installation of a virtual environment works from scratch (on a linux system).	2023-10-17 09:09:35 +02:00
setup.py	Open API 3.0	2023-03-02 09:22:37 +01:00

README.md

BreCal

OpenAPI 3.0 Generated Flask project

The code was originally created by exporting the API from Postman. Selecting the API on the left (root element) the code generation icon becomes visible on the right.

If the API gets updated I think it makes most sense to export again into a API helper branch and then merge this branch back into the project. Please do not forget to update the index.yaml file. The branch is named yaml_export.

All the routes are defined in 'project/api' folder. Each route parses the request and calls the corresponding function in the 'project/impl' directory passing all the parameters and request body as function arguments.

To run this project:

pip install -r requirements.txt
export FLASK_APP='BreCal'
export FLASK_ENV=development
flask run