Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 2.54 KB

README.md

File metadata and controls

59 lines (36 loc) · 2.54 KB
Raw

Contact informations

You are a city, a mobility provider or you simply want to know more about our MDS tools: send us a mail at [email protected]

django-mds - MDS compliant mobility data service

Build Status

A City of LA MDS Specification (Mobility Data Specification) compliant implementation of the Agency API for Python/Django

Goals & non-goals

Goals

  • Ultimately MDS compliance
  • A way to test MDS ideas on a real implementation as we believe it is hard to specify a quality API without a reference implementation alongside
  • Developer-friendly to be able for all stakeholders to contribute

Non-goals

  • High-performance: we favor developer-friendliness over performance (this software being stateless, scaling is trivial anyway. Just the database needs to be correctly dimensioned)
  • Full-featured UI: we provide an UI with required features, but this remains an API-first software
  • Data-analysis: analysis should be done by other apps consuming the consumer API of this app (the API must be designed to allow data consumption by third-party software)

Tech & requirements

  • Python 3 with Django and GeoDjango
  • Postgresql with PostGIS
  • Swagger for interactive API documentation (available on /schema)

How to run

Test project

  • Install and configure requirements (see above)
  • Run pip install .[dev] to install dependencies
  • You need the following env variables: MDS_DB_NAME, MDS_DB_USER and MDS_DB_PASSWORD
  • To initialize the database, run python manage.py migrate
  • To start the project locally, run MDS_DEV_DEBUG=1 python manage.py runserver

A sample environment configuration is provided in .env.example

Authentication

Request authentication is done through JWT bearer token as specified in MDS JWT secret key or public key should be given through environment configuration MDS_AUTH_SECRET_KEY or MDS_AUTH_PUBLIC_KEY

Frontend

See dedicated README in front/README.md

Release

We use semantic versioning and zest.releaser for the actual release:

fullrelease

Just follow the steps and hit Enter to answer Yes.