Metadata-Version: 2.1
Name: gtfs.py
Version: 0.1
Summary: A simple python library for parsing, editing and writing GTFS files
Home-page: https://github.com/WYishai/gtfs.py
Author: Yishai Wiesner
Author-email: wyishai@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Other Audience
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
Requires-Dist: sortedcontainers

# gtfs.py

A simple python library for parsing, editing and writing GTFS files.

GTFS (General Transit Feed Specification) is a format which determined by google in order to defines a common format for public transportation static data (schedules, stops location, etc.). For more information about the format you can read [here](https://developers.google.com/transit/gtfs) and [here](https://en.wikipedia.org/wiki/General_Transit_Feed_Specification).

## Getting Started

### Installing

You can install this package with pip.

```
pip install gtfs.py
```

If you want to contribute to the library code, you have to clone if from github and install it as a developer.

```
git clone https://github.com/WYishai/gtfs.py.git
cd gtfs.py
cd src
python setup.py develop
```

### Usage

All examples are intended for writing in a python shell (or python code file).

Creating a new TransitData object:
```
from gtfspy import TransitData

td = TransitData()
...
```

Loading existing GTFS file:
```
from gtfspy import TransitData

gtfs_file_path = "/path/to/file"
td = TransitData(gtfs_file_path)
...
```

Additional examples are in the [examples folder](https://github.com/WYishai/gtfs.py/blob/master/examples) in the [GIT repository](https://github.com/WYishai/gtfs.py).

## Running the tests

This project contains unit tests that covers most of the source code. In order to run the tests, you must first install the project as a developer (as mentioned at the _Installing_ section. After the installation you can run them by typing the following commands in your shell:
```
cd [PROJECT_DIR]\tests
python -m unittest discover gtfspy
```
Of course, _[PROJECT_DIR]_ must be replaced by the path you cloned the GIT repository into it.

## License

This project is licensed under the Apache-2.0 License - see the [LICENSE](https://github.com/WYishai/gtfs.py/blob/master/LICENSE) file for details


