- VirtualBox (https://www.virtualbox.org/)
- Vagrant (https://www.vagrantup.com/)
Start the vagrant VMs.
vagrant up
Browse some of the available services:
- Brutus API: http://127.0.0.1:5000/
- Brutus Math Module: http://127.0.0.1:5010/
- Brutus Weather Module: http://127.0.0.1:5020/
Create a Python 3 virtualenv:
virtualenv --python=$(which python3) env
source env/bin/activate
Install the required python packages:
pip install -r src/brutus-api/requirements.txt
Install the project as an in-place editable package:
pip install -e $(pwd)/src/brutus-api
Run the project:
brutus_api --host 0.0.0.0 --port 5000
Run the worker for background tasks:
rq worker
Navigate to the project directory and run the tests using Make targets:
cd src/brutus-api
make test-style # run style tests
make test-unit # run unit tests
make test # run all tests
- Python
- PEP8 Style Guide: https://www.python.org/dev/peps/pep-0008/
- Python RQ: http://python-rq.org/docs/
- Pytest: http://docs.pytest.org/en/latest/
- Responses: https://github.com/getsentry/responses
- HTTTPretty: https://github.com/gabrielfalcao/HTTPretty