assess-gtfs 0.0.4

Inspect & validate General Transit Feed Specification

assess_gtfs

:warning: This repository is still in the development phase. Caution should be taken before using or referencing this work in any way - use it at your own risk.

Introduction

assess_gtfs provides a method for inspecting and validating General Transit Feed Specification.

Developers

We welcome contributions from others. Please check out our code of conduct and contributing guidance.

Installation

Describe technical set-up. Such as the required dependencies.

This package is designed to work with python 3.9.13. Full functionality is tested on macos only.

Usage

Installation

Currently, assess_gtfs is not published to PyPI or Conda Forge. To use the code, we suggest forking the repository and cloning the fork to your development environment.

git clone <INSERT_CLONE_URL>/assess_gtfs.git

We recommend running the package with a virtual environment such as conda or venv.

With conda:

conda create -n assess-gtfs python=3.9.13 -y

Once completed, activate the environment:

conda activate assess-gtfs

Install the python package with dependencies:

pip install .

If contributing to assess_gtfs, install optional dependencies:

pip install -e '.[test,docs]'

Additional Java dependencies are required for full functionality. See the contributing guidance for assistance.

Required Data

You will need Public Transport Schedule data in GTFS format, appropriate to the territory that you wish to analyse.

Data Science Campus

At the Data Science Campus we apply data science, and build skills, for public good across the UK and internationally. Get in touch with the Campus at [e-mail].

License

The code, unless otherwise stated, is released under the MIT Licence.

The documentation for this work is subject to © Crown copyright and is available under the terms of the Open Government 3.0 licence.