Building Permits API

Use SFDS Building Permits API for interacting with building permit applications

Requirements

Install Pipenv (if needed)

$ pip install --user pipenv

Install included packages

$ pipenv install

Set environment variables which are listed in the .env.example file

Set ACCESS_KEY environment var and start WSGI Server

$ ACCESS_KEY=123456 pipenv run gunicorn 'service.microservice:start_service()'

Run celery worker

$ pipenv run celery worker

Start celery beat work

$ pipenv run celery -A tasks beat --loglevel=info

Run Pytest

$ pipenv run python -m pytest

Get code coverage report

$ pipenv run python -m pytest --cov=service tests/ --cov-fail-under=100

Open with cURL or web browser

$ curl --header "ACCESS_KEY: 123456" http://127.0.0.1:8000/welcome

Auto-reload on code changes

$ ACCESS_KEY=123456 pipenv run gunicorn --reload 'service.microservice:start_service()'

Code coverage command with missing statement line numbers

$ pipenv run python -m pytest -s --cov=service --cov=tasks tests/ --cov-report term-missing

Set up git hook scripts with pre-commit

$ pipenv run pre-commit install

CircleCI builds fail when trying to run coveralls.
1. Log into coveralls.io to obtain the coverall token for your repo.
2. Create an environment variable in CircleCI with the name COVERALLS_REPO_TOKEN and the coverall token value.