sensors.AFRICA API

API to save and access data from deployed sensors in cities all around Africa.

Documentation

The API is documented

here.

Development

Gitignore is standardized for this project using

gitignore.io

Clone this repo

Virtual environment

Use virtualenv to create your virtual environment; virtualenv venv

Activate the virtual environment; source venv/bin/activate

Install feinstaub; pip install git+https://github.com/opendata-stuttgart/feinstaub-api

Install the requirements; pip install .

Create a sensorsafrica database with the following sql script:

CREATE DATABASE sensorsafrica; CREATE USER sensorsafrica WITH ENCRYPTED PASSWORD 'sensorsafrica'; GRANT ALL PRIVILEGES ON DATABASE sensorsafrica TO sensorsafrica;

Migrate the database; python manage.py migrate

Run the server; python manage.py runserver

Docker

Using docker compose:

Build the project; docker-compose build or make build

Run the project; docker-compose up -d or make up

Docker compose make commands:

make build

make up - run docker and detach

make log - tail logs

make test - run test

make migrate - migrate database

make createsuperuser - create a super user for admin

make compilescss

make enter - enter docker shell

make django - enter docker django shell

NOTE: docker-compose is strictly for development and testing purposes. The Dockerfile is written for production since dokku is being used and it will look for Dockerfile.

Tests

Virtual Environment; pytest --pylama

Docker; docker-compose run api pytest --pylama

NOTE: If entrypoint and start scripts are changed, make sure they have correct/required permissions since we don't grant permissions to the files using the Dockerfile. Run the commands:

chmod +x contrib/entrypoint.sh chmod +x contrib/start.sh

Deployment

Dokku

On your local machine run:

git remote add dokku dokku@dokku.me:sensorsafrica-api git push dokku master

For more information read

Deploying to Dokku

Cronjob

This project uses celery to create cronjobs and flower to monitor the cron jobs as a web admin. To create your jobs, add the task to the tasks.py and CELERY_BEAT_SCHEDULE in settings.py.

Everything starts automatically as setup in the contrib/start.sh:

celery -A sensorsafrica beat -l info &> /src/logs/celery.log & celery -A sensorsafrica worker -l info &> /src/logs/celery.log & celery -A sensorsafrica flower --basic_auth=$SENSORSAFRICA_FLOWER_ADMIN_USERNAME:$SENSORSAFRICA_FLOWER_ADMIN_PASSWORD &> /src/logs/celery.log &

Note: If you run the project in the virtualenv you will have to start rabbitmq and pass that link to settings by the env variable SENSORSAFRICA_RABBITMQ_URL

Monitoring

Flower

It starts up in in the contrib/start.sh:

... celery -A sensorsafrica flower --basic_auth=$SENSORSAFRICA_FLOWER_ADMIN_USERNAME:$SENSORSAFRICA_FLOWER_ADMIN_PASSWORD &> /src/logs/celery.log &

Slack

Provide channel webhook as an enivronment variable SENSORSAFRICA_CELERY_SLACK_WEBHOOK. The default options are used:

Sentry

Set the enivronment variable SENSORSAFRICA_SENTRY_DSN.

Archiving

Contributing

opendata-stuttgart/feinstaub-api

Hence, with any contribution, include both sensors.AFRICA-api and opendata-stuttgart/feinstaub-api migration files by running python manage.py makemigrations command before creating a PR.

License

GNU GPLv3

Copyright (C) 2018 Code for Africa

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see

https://www.gnu.org/licenses/