Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kylebarron/transitland_wrapper
Python wrapper for transit.land API
https://github.com/kylebarron/transitland_wrapper
api gtfs gtfs-feed python transit transit-data transitland
Last synced: about 2 months ago
JSON representation
Python wrapper for transit.land API
- Host: GitHub
- URL: https://github.com/kylebarron/transitland_wrapper
- Owner: kylebarron
- License: mit
- Created: 2020-02-08T16:59:36.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-02-24T04:55:10.000Z (almost 5 years ago)
- Last Synced: 2024-10-11T09:26:40.206Z (2 months ago)
- Topics: api, gtfs, gtfs-feed, python, transit, transit-data, transitland
- Language: Python
- Size: 37.1 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Transit.land API wrapper
Simple Python wrapper around API.
## Install
```
pip install transitland_wrapper
```
## CLI
All CLI commands write a list of GeoJSON `Feature`s to stdout. This way minimal
results are kept in memory at once. If a `geometry` is passed, the geometry's
bounding box is given to the transit.land API, and results are tested for
intersection with the original geometry. The `geometry` file must be readable by
GeoPandas and will automatically be reprojected to EPSG 4326 if necessary. The
geometry type must be either `Point`, `Polygon`, `MultiPolygon`, `LineString`,
or `MultiLineString`.
### Operators
```
Usage: transitland operators [OPTIONS]
Request operators info
Options:
-b, --bbox TEXT Bounding box to search within
-g, --geometry PATH File with geometry to use. Must be readable by
GeoPandas
-r, --radius FLOAT radius in meters to search around, default 100m
for Point geometries. Used only for Point
geometries.
--gtfs-id TEXT ID used in a GTFS feed's agencies.txt file
-p, --per-page INTEGER Number of results per page [default: 50]
--page-all / --no-page-all Page over all responses [default: False]
--help Show this message and exit.
```
### Routes
```
Usage: transitland routes [OPTIONS]
Request routes info
Options:
-b, --bbox TEXT Bounding box to search within
-g, --geometry PATH File with geometry to use. Must be readable
by GeoPandas
-r, --radius FLOAT radius in meters to search around, default
100m for Point geometries. Used only for
Point geometries.
--operated-by TEXT search by operator onestop_id or route
onestop_id
--vehicle-type TEXT find all routes with vehicle type(s) by
integer or string. Possible values defined
by the GTFS spec for the route_type column
and the Extended GTFS Route Types
--gtfs-id TEXT ID used in a GTFS feed's routes.txt file
--include-geometry / --no-include-geometry
Include route geometry [default: True]
-p, --per-page INTEGER Number of results per page [default: 50]
--page-all / --no-page-all Page over all responses [default: False]
--help Show this message and exit.
```
### Stops
```
Usage: transitland stops [OPTIONS]
Request stops info
Options:
-b, --bbox TEXT Bounding box to search within
-g, --geometry PATH File with geometry to use. Must be readable by
GeoPandas
-r, --radius FLOAT radius in meters to search around, default 100m
for Point geometries. Used only for Point
geometries.
--served-by TEXT search by operator onestop_id or route
onestop_id
--gtfs-id TEXT ID used in a GTFS feed's stops.txt file
-p, --per-page INTEGER Number of results per page [default: 50]
--page-all / --no-page-all Page over all responses [default: False]
--help Show this message and exit.
```
### Route Stop Patterns
```
Usage: transitland route-stop-patterns [OPTIONS]
Request routes info
Options:
-b, --bbox TEXT Bounding box to search within
-g, --geometry PATH File with geometry to use. Must be readable by
GeoPandas
--traversed-by TEXT find all Route Stop Patterns belonging to route
--stops-visited TEXT any one or more stop Onestop IDs, separated by
comma. Finds Route Stop Patterns with
stops_visited in stop_pattern
--trips TEXT any one or more trip ids, separated by comma.
Finds Route Stop Patterns with specified trips
in trips
-p, --per-page INTEGER Number of results per page [default: 50]
--page-all / --no-page-all Page over all responses [default: False]
--help Show this message and exit.
```
### Schedule Stop Pairs
```
Usage: transitland schedule-stop-pairs [OPTIONS]
Request schedule stop pairs info
Options:
-b, --bbox TEXT Bounding box to search within
-g, --geometry PATH File with geometry to use. Must be readable
by GeoPandas
--origin-onestop-id TEXT Find all Schedule Stop Pairs from origin
--destination-onestop-id TEXT Find all Schedule Stop Pairs to a
destination
--date TEXT Find all Schedule Stop Pairs from origin on
date
--service-from-date TEXT Find all Schedule Stop Pairs in effect from
a date
--service-before-date TEXT Find all Schedule Stop Pairs in effect
before a date
--origin-departure-between TEXT
Find all Schedule Stop Pairs with
origin_departure_time in a range
--trip TEXT Find all Schedule Stop Pairs by trip
identifier
--route-onestop-id TEXT Find all Schedule Stop Pairs by route
--operator-onestop-id TEXT Find all Schedule Stop Pairs by operator
--active / --no-active Schedule Stop Pairs from active FeedVersions
[default: True]
-p, --per-page INTEGER Number of results per page [default: 50]
--page-all / --no-page-all Page over all responses [default: False]
--help Show this message and exit.
```
### Onestop ID
```
Usage: transitland onestop-id [OPTIONS]
Request onestop_id info
Options:
--oid TEXT a Onestop ID for any type of entity (for example, a stop or
an operator)
-f, --file PATH a file with one or more Onestop IDs, with each on their own
line.
--help Show this message and exit.
```
### Feeds
```
Usage: transitland feeds [OPTIONS]
Request feeds info
Options:
-b, --bbox TEXT Bounding box to search within
-g, --geometry PATH File with geometry to use. Must be readable by
GeoPandas
-p, --per-page INTEGER Number of results per page [default: 50]
--page-all / --no-page-all Page over all responses [default: False]
--help Show this message and exit.
```
## Python API
Each function returns a _generator_ of results, because there could be an
unknown amount of paging involved. Each item of the iterator is a list of
GeoJSON `Feature`s.
```py
import transitland_wrapper
transitland_wrapper.stops()
transitland_wrapper.operators()
transitland_wrapper.routes()
transitland_wrapper.route_stop_patterns()
transitland_wrapper.schedule_stop_pairs()
transitland_wrapper.onestop_id()
transitland_wrapper.feeds()
```
### Stops
```
- geometry: either Point, to search a radius around a point, or a
Polygon or MultiPolygon, to search for stops within the geometry. If a
Polygon or MultiPolygon is provided, the search will be done by
bounding box, and then results will be filtered for intersection.
- radius: radius in meters to search around, default 100m for Point
geometries. Not used for Polygon geometries.
- served_by: search by operator onestop_id or route onestop_id
- gtfs_id: ID used in a GTFS feed's stops.txt file
- per_page: number of results per page, by default 50
- page_all: page over all responses
```
### Operators
```
- geometry: either Point, to search a radius around a point, or a
Polygon or MultiPolygon, to search for stops within the geometry. If a
Polygon or MultiPolygon is provided, the search will be done by
bounding box, and then results will be filtered for intersection.
- radius: radius in meters to search around, default 100m for Point
geometries. Not used for Polygon geometries.
- gtfs_id: ID used in a GTFS feed's agencies.txt file
- per_page: number of results per page, by default 50
- page_all: page over all responses
```
### Routes
```
- geometry: either Point, to search a radius around a point, or a
Polygon or MultiPolygon, to search for stops within the geometry. If a
Polygon or MultiPolygon is provided, the search will be done by
bounding box, and then results will be filtered for intersection.
- radius: radius in meters to search around, default 100m for Point
geometries. Not used for Polygon geometries.
- operated_by: search by operator onestop_id
- vehicle_type: find all routes with vehicle type(s) by integer or
string. Possible values defined by the GTFS spec for the route_type
column and the Extended GTFS Route Types.
- include_geometry: If True, includes route geometry. Default: True
- gtfs_id: ID used in a GTFS feed's routes.txt file
- per_page: number of results per page, by default 50
- page_all: page over all responses
```
### Route Stop Patterns
```
- geometry: either Polygon or MultiPolygon, to search for stops within
the geometry. If a Polygon or MultiPolygon is provided, the search
will be done by bounding box, and then results will be filtered for
intersection.
- traversed_by: find all Route Stop Patterns belonging to route
- stops_visited: any one or more stop Onestop IDs, separated by comma. Finds Route Stop Patterns with stops_visited in stop_pattern.
- trips: any one or more trip ids, separated by comma. Finds Route Stop Patterns with specified trips in trips.
- per_page: number of results per page, by default 50
- page_all: page over all responses
```
### Schedule Stop Pairs
```
- geometry: either Polygon or MultiPolygon, to search for stops within
the geometry. If a Polygon or MultiPolygon is provided, the search
will be done by bounding box, and then results will be filtered for
intersection.
- origin_onestop_id: Find all Schedule Stop Pairs from origin. Accepts multiple Onestop IDs, separated by commas
- destination_onestop_id: Find all Schedule Stop Pairs to a destination. Accepts multiple Onestop IDs, separated by commas
- date: Find all Schedule Stop Pairs from origin on date
- service_from_date: Find all Schedule Stop Pairs in effect from a date
- service_before_date: Find all Schedule Stop Pairs in effect before a date
- origin_departure_between: Find all Schedule Stop Pairs with origin_departure_time in a range
- trip: Find all Schedule Stop Pairs by trip identifier
- route_onestop_id: Find all Schedule Stop Pairs by route. Accepts multiple Onestop IDs, separated by commas.
- operator_onestop_id: Find all Schedule Stop Pairs by operator. Accepts multiple Onestop IDs, separated by commas.
- active: Schedule Stop Pairs from active FeedVersions
- per_page: number of results per page, by default 50
- page_all: page over all responses
```
### Onestop ID
```
- oid: a Onestop ID for any type of entity (for example, a stop or an operator)
```
### Feeds
```
- geometry: either Polygon or MultiPolygon, to search for stops within
the geometry. If a Polygon or MultiPolygon is provided, the search
will be done by bounding box, and then results will be filtered for
intersection.
```
## Contributing
To release to PyPI:
```
bumpversion minor
python setup.py sdist
twine upload dist/transitland_wrapper-0.1.0.tar.gz
```