This work was created as part of the RVA Data Summit Workshop 2020 session, "Introduction to Data Engineering."
It provides a tested, deployable REST microservice that returns a calculated value.
For information on how to work with the microservice, see specification.yaml.
Please install Docker, Pip and Python3
On Mac:
brew install docker
brew install python3
To run the service locally:
Install the requirements
pip install -r requirements.txt
Install an editable, local version of the package
pip install -e .
Run the service locally
python3 app.py
Build and run the service in a container
docker build -t rvadatasummit/intro .
docker run -d -p 5000:5000 rvadatasummit/intro
You can run the tests using the Python pytest module.
pytest
To deploy in the cloud, follow instructions for your cloud provider:
- Python - Used to write the service
- Flask - Used as the web framework
- Docker - Used to run the service in a container
If you'd like to contribute please create a feature branch and a pull request. For more information on contributing best practices, check out the excellent contributing guidelines provided by Pandas.
- Jackie Goldschmidt - Initial work
See also the list of contributors who participated in this project.
This project is licensed under the MIT License, as can be seen in the LICENSE file.
- Thank you to PurpleBooth for the README template