MDS Agency implementation
Project description
django-mds - MDS compliant mobility data service
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
Backend
- Install and configure requirements (see above)
- Run
pip install .[dev]
to install dependencies - You need following env variables:
MDS_DB_NAME
,MDS_DB_USER
andMDS_DB_PASSWORD
- To initialize the database, run
python manage.py migrate
- To start the backend locally, run
MDS_DEV_DEBUG=1 python manage.py runserver
Frontend
See dedicated README in front/README.md
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
django-mds-0.1.0.tar.gz
(50.5 kB
view hashes)
Built Distribution
django_mds-0.1.0-py3-none-any.whl
(52.9 kB
view hashes)
Close
Hashes for django_mds-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5722f03e1d7a73bcdfb098901a66f7aa38c6d569021593fee54066554e3c3d72 |
|
MD5 | 0f5f6530ede38d8a70d0b278a5c1f956 |
|
BLAKE2b-256 | c8d3cc6cb384647e8f308982ab9ad913aefd540e03b1f24d164a3cdacc3ba47d |