Currently developing scripts to facilitate data transfer between sensor device manufactures and IDEA-FAST's internal data platform, and a separate API to provide updates on device wear and use.
Poetry is used for dependency management and pyenv to manage python installations, so please install both on your local machine. We use python 3.8 by default, so please make sure this is installed via pyenv, e.g.
pyenv install 3.8.0 && pyenv global 3.8.0
Once done, you can install dependencies for this project via:
poetry install
To setup a virtual environment with your local pyenv version run:
poetry shell
Copy .NAME.env.example file to .NAME.env where NAME is the python package (consumer, data_transfer).
Then add relevant local/live values and credentials.
When developing the consumer API run:
poetry run consumer
When developing the data transfer jobs run:
poetry run dtransfer
Semantic versioning is used when core changes are merged
to master to enable continuous deployment. To build an image locally where $VERSION
for your desired version:
poetry run build $VERSION
The compose file contains all environmental variables and runs all services:
poetry run compose
We use Docker Hub to store images. To push
to your own image, update REGISTRY inside cli.py and run:
poetry run publish $VERSION
Interactive documentation is available in Swagger (/docs) and ReDoc (/redoc).