search

tulsawebdevs / django-multi-gtfs

Django app to import and export General Transit Feed Specification (GTFS)
http://tulsawebdevs.org/
Apache License 2.0
50 stars 32 forks source link

readme

=============================== multigtfs: GTFS as a Django app

.. image:: https://img.shields.io/pypi/v/multigtfs.svg :alt: The PyPI package :target: https://pypi.python.org/pypi/multigtfs

.. image:: https://img.shields.io/travis/tulsawebdevs/django-multi-gtfs/master.svg :alt: TravisCI Build Status :target: https://travis-ci.org/tulsawebdevs/django-multi-gtfs

.. image:: https://img.shields.io/coveralls/tulsawebdevs/django-multi-gtfs/master.svg :alt: Coveralls Test Coverage :target: https://coveralls.io/r/tulsawebdevs/django-multi-gtfs?branch=master

.. Omit badges from docs

multigtfs is an Apache 2.0-licensed Django app that supports importing and exporting of GTFS feeds. All features of the June 20, 2012 reference are supported, including all changes_ up to February 17, 2014. It allows multiple feeds to be stored in the database at once.

It requires a spatial databases compatible with GeoDjango. PostgreSQL 9.x and PostGIS_ 2.x are recommended for development and production, since these support all the GeoDjango features.

Status

multigtfs is ready for your GTFS project.

Point releases (such as 1.0.0 to 1.0.1) should be safe, only adding features or fixing bugs. Minor updates (1.0.1 to 1.1.0) may include significant changes that will break relying code. In the worst case scenario, you may need to export your GTFS feeds in the original version, update multigtfs and your code, and re-import.

multigtfs works with Django 1.8 (the long-term support, or LTS, release) through 1.11 (the next LTS release), and 2.0. Support will follow the Django supported releases, as well as the Python versions supported by those releases.

All valid GTFS feeds are supported for import and export. This includes feeds with extra columns not yet included in the GTFS spec, and feeds that omit calendar.txt in favor of calendar_dates.txt (such as the TriMet archive feeds). If you find a feed that doesn't work, file a bug_!

See the issues list_ for more details on bugs and feature requests.

Example project

Check out the example project_.

If you have Docker_ installed and working, you can run the example project without installing a database.

. Add one or more feeds to import to the folder feeds/import. You can find

a feed for download at https://transitfeeds.com, such as Tulsa Transit's Feed_.

. Initialize the containers with docker-compose up. After a few

minutes, it will display::

web_1  | Django version 1.8.18, using settings 'exploreproj.settings'
web_1  | Development server is running at http://0.0.0.0:8000/
web_1  | Using the Werkzeug debugger (http://werkzeug.pocoo.org/)
web_1  | Quit the server with CONTROL-C.
web_1  |  * Debugger is active!
web_1  |  * Debugger PIN: XXX-XXX-XXX

. Visit http://localhost:8000 to view the example project.

See the example project_ for more details.

Development

:Code: https://github.com/tulsawebdevs/django-multi-gtfs :Issues: https://github.com/tulsawebdevs/django-multi-gtfs/issues :Dev Docs: http://multigtfs.readthedocs.io/ :IRC: irc://irc.freenode.net/tulsawebdevs

.. Apache 2.0: http://choosealicense.com/licenses/apache/ .. June 20, 2012 reference: https://developers.google.com/transit/gtfs/reference .. _all changes: https://developers.google.com/transit/gtfs/guides/revision-history .. _PostgreSQL: http://www.postgresql.org .. _PostGIS: http://postgis.refractions.net .. GeoDjango: https://docs.djangoproject.com/en/dev/ref/contrib/gis/ .. file a bug: https://github.com/tulsawebdevs/django-multi-gtfs/issues .. issues list: https://github.com/tulsawebdevs/django-multi-gtfs/issues?state=open .. example project: examples/explore/README.md .. Docker: https://www.docker.com .. Tulsa Transit's Feed: https://transitfeeds.com/p/tulsa-transit/521