The Mapseed API is the data storage and data management component that powers the Mapseed web application. It is a REST API for flexibly storing data about places and an UI for managing and exporting your data.
- python 3.7
- virtualenv
- virtualenv can be made with the following command:
mkvirtualenv --python=python3.7 ms-api
- virtualenv can be made with the following command:
- Docker
- docker-compose
pip install -r requirements.txt
Note that on MacOS, if you are having error building psycopg2, you may need the following:
env LDFLAGS="-I/usr/local/opt/openssl/include -L/usr/local/opt/openssl/lib" pip install psycopg2
https://stackoverflow.com/a/39244687
We use Black as our code formatter, along with isort. Editor integration is encouraged.
You can format the entire project in one command with black . from the project root. Tests will be check by running black --check . from the project root.
TOOD: consider using pre-commit hook as described here and here