Shallow-Dives/mbta-lite-map-api

An API supporting the the MBTA Lite Map - a Raspberry Pi powered LED map of the MBTA Red Line in Boston.

Python

MBTA Lite Map API

API supporting the MBTA Lite Map Project.

Develop workflow

The development workflow commands are aliased in the Makefile.

Install development dependencies
```
 make devel-install
```
Create and populate a .env file based on .env.template
```
 cp .env.template .env
```
The USER_API_KEY is required to access any restricted endpoints in this application. A user API key can be generated with uuid-gen and then provided to the Raspberry Pi frontend node(s). Keys to access any external APIs should also be added via .env.

Lint and reformat any new code

  make format          # Reformats all code

  make format-check    # Reports issues but doesn't auto-format

Run tests with Pytest
```
  make test
```
The pytest configuration is specified and can be updated in tests/pytest.ini.
Build and run the API image
```
  make devel-build

  make devel-run
```
This kicks off a multi-stage docker build to create a pared down final image running a Gunicorn server.

Deploy workflow

TODO

docker compose up

Resources