Go to file
2024-07-09 12:40:00 +02:00
bin Added LICENSE 2024-07-08 22:10:53 +02:00
docs Added LICENSE 2024-07-08 22:10:53 +02:00
Scripts Reorganizing code, adding stops display, connect with backend 2024-06-11 20:40:18 +02:00
transport_accessibility Added Copying to app 2024-07-09 03:17:12 +02:00
.gitignore Added built docs 2024-06-11 22:17:31 +02:00
.readthedocs.yaml Added LICENSE 2024-07-08 22:10:53 +02:00
COPYING Added LICENSE 2024-07-08 22:10:53 +02:00
COPYING.md Added LICENSE 2024-07-08 22:10:53 +02:00
delete_db.sql Added LICENSE 2024-07-08 22:10:53 +02:00
lib64 Set up venv with Django and mysqlclient 2024-05-31 21:53:52 +02:00
pyvenv.cfg Added LICENSE 2024-07-08 22:10:53 +02:00
README.md Added Copying to app 2024-07-09 03:17:12 +02:00
requirements.txt Started adding tests to tests for the models' integrity with GTFS 2024-06-27 13:01:56 +02:00
setup_db.sql Added LICENSE 2024-07-08 22:10:53 +02:00
TODO.md Signing properly 2024-07-09 12:38:15 +02:00

transport-accessibility

Tool for cities to easily publish their public transport in a standardized form

Public transport is often provided by many, smaller companies, operating mostly in their respective regions. A problem deriving from this is that, on a interregional, national and international, few machine-readable data is available. This impacts customers, as it makes it more difficult to find public transport routes, more so while travelling in regions they are less familiar with.

We designed a tool to provide city officials or volunteers to map the public transport in their jurisdiction using an easy-to-use graphical utility. https://www.gnu.org/software/make/

Installation instructions

Dependencies

First, make sure to have all dependencies installed:

  • An up-to-date version of Python and pip.
  • The project's Python dependencies. We strongly recommend using a virtual environment and install the dependencies using pip install -r requirements.txt in the project's root directory.
  • An up-to-date version of Mariadb
  • If you want to build the documentation, you will need Sphinx and Make

Database

  • The database can be installed using sudo mariadb -u root < setup_db.sql
  • The migrations should be applied using python transport_accessibility/manage.py migrate
  • If you are having database problems and where using an old version of the database before, try resetting the database by issuing sudo mariadb -u root < delete_db.sql && sudo mariadb -u root < setup_db.sql, as we changed the character encoding in one of the earlier commits.

Load example data

  • Download some real or sample GTFS data from the Internet.
  • Open a django shell: python transport_accessibility/manage.py shell
  • Import the database bridging functions: import pt_map.gtfs, pt_map.bridge
  • Load sample data to db: pt_map.bridge.gtfs_to_db(pt_map.gtfs.GTFS("/path/to/folder")) (This might take some time)

Run, study, improve, share.

Copying

Code

The project's is free software, with it's source code licensed under the AGPL. For detailed license information, see the license text, as found in the file named COPYING in the project's root directory or at the GNU project's website.

Documentation

The project's documentation, including this file, is free, too, licensed under the GNU project's Free Documentation License (FDL). Detailed information can be found in the documentation's root directory in a file called COPYING_DOCS or at the GNU project's website.

Copyright (C) 2024 Janek Kiljanski, Johannes Randerath