partridge 0.6.0

Partridge is python library for working with GTFS feeds using pandas DataFrames.

Partridge

Partridge is python library for working with GTFS feeds using pandas DataFrames.

The implementation of Partridge is heavily influenced by our experience at Remix ingesting, analyzing, and debugging thousands of GTFS feeds from hundreds of agencies.

At the core of Partridge is a dependency graph rooted at trips.txt. Disconnected data is pruned away according to this graph when reading the contents of a feed. The root node can optionally be filtered to create a view of the feed specific to your needs. It’s most common to filter a feed down to specific dates (service_id), routes (route_id), or both.

Philosphy

The design of Partridge is guided by the following principles:

• as much as possible

  • favor speed

  • allow for extension

  • succeed lazily on expensive paths

  • fail eagerly on inexpensive paths

• as little as possible

  • do anything other than efficiently read GTFS files into DataFrames

  • take an opinion on the GTFS spec

Usage

import datetime
import partridge as ptg

path = 'path/to/sfmta-2017-08-22.zip'

service_ids_by_date = ptg.read_service_ids_by_date(path)

service_ids = service_ids_by_date[datetime.date(2017, 9, 25)]

feed = ptg.feed(path, view={
    'trips.txt': {
        'service_id': service_ids,
        'route_id': '12300', # 18-46TH AVENUE
    },
})

assert set(feed.trips.service_id) == service_ids
assert list(feed.routes.route_id) == ['12300']

# Buses running the 18 - 46th Ave line use 88 stops (on September 25, 2017, at least).
assert len(feed.stops) == 88

Features

• Surprisingly fast :)

• Load only what you need into memory

• Built-in support for resolving service dates

• Easily extended to support fields and files outside the official spec (TODO: document this)

• Handle nested folders and bad data in zips

• Predictable type conversions

Installation

pip install partridge

Thank You

I hope you find this library useful. If you have suggestions for improving Partridge, please open an issue on GitHub.

History

0.6.0 (2018-02-21)

• Published package no longer includes unnecessary fixtures to reduce the size.

• Naively write a feed object to a zip file with ptg.write_feed_dangerously.

• Read the earliest, busiest date and it’s service_id`s from a feed with `ptg.read_busiest_date.

• Bug fix: Handle calendar.txt/calendar_dates.txt entries w/o applicable trips.

0.6.0.dev1 (2018-01-23)

• Add support for reading files from a folder. Thanks again @danielsclint!

0.5.0 (2017-12-22)

• Easily build a representative view of a zip with ptg.get_representative_feed. Inspired by peartree.

• Extract out GTFS zips by agency_id/route_id with ptg.extract_{agencies,routes}.

• Read arbitrary files from a zip with feed.get('myfile.txt').

• Remove service_ids_by_date, dates_by_service_ids, and trip_counts_by_date from the feed class. Instead use ptg.{read_service_ids_by_date,read_dates_by_service_ids,read_trip_counts_by_date}.

0.4.0 (2017-12-10)

• Add support for Python 2.7. Thanks @danielsclint!

0.3.0 (2017-10-12)

• Fix service date resolution for raw_feed. Previously raw_feed considered all days of the week from calendar.txt to be active regardless of 0/1 value.

0.2.0 (2017-09-30)

• Add missing edge from fare_rules.txt to routes.txt in default dependency graph.

0.1.0 (2017-09-23)

• First release on PyPI.