Metadata-Version: 2.4
Name: gtfs-cli
Version: 0.1.0
Summary: CLI tool to fetch, archive, process and explore GTFS-RT data
Project-URL: Homepage, https://github.com/VMois/gtfs-cli
Project-URL: Repository, https://github.com/VMois/gtfs-cli
Project-URL: Bug Tracker, https://github.com/VMois/gtfs-cli/issues
Author: Vladyslav Moisieienkov
License-Expression: MIT
License-File: LICENSE
Keywords: cli,gtfs,gtfs-rt,realtime,transit
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: GIS
Requires-Python: >=3.11
Requires-Dist: gtfs-realtime-bindings>=1.0.0
Requires-Dist: httpx>=0.28.0
Requires-Dist: protobuf>=5.0.0
Requires-Dist: rich>=13.0.0
Requires-Dist: typer>=0.15.0
Description-Content-Type: text/markdown

# gtfs-cli

CLI tool to fetch, archive, process and explore [GTFS-RT](https://gtfs.org/documentation/realtime/reference/) (General Transit Feed Specification — Realtime) data. GTFS-RT feeds provide live transit information: trip updates, vehicle positions, and service alerts in protobuf format.

## Installation

```bash
uv tool install gtfs-cli
```

After installation, the `gtfs-cli` command is available globally.

## Commands

### `fetch`

Fetch a GTFS-RT feed from a URL or local file and output it as JSON.

```bash
# Fetch live trip updates
gtfs-cli fetch "https://gtfsrt.ttc.ca/trips/update?format=binary"

# Fetch vehicle positions
gtfs-cli fetch "https://gtfsrt.ttc.ca/vehicles/position?format=binary"

# Fetch service alerts
gtfs-cli fetch "https://gtfsrt.ttc.ca/alerts/all?format=binary"

# Inspect a previously saved .pb file
gtfs-cli fetch trips.pb
```

**Filtering with jq:**

```bash
# List all active alerts
gtfs-cli fetch "https://gtfsrt.ttc.ca/alerts/all?format=binary" | jq '.entity[] | .alert'

# Count entities in a feed
gtfs-cli fetch "https://gtfsrt.ttc.ca/trips/update?format=binary" | jq '.entity | length'

# Extract all trip IDs
gtfs-cli fetch "https://gtfsrt.ttc.ca/trips/update?format=binary" \
  | jq '[.entity[].trip_update.trip.trip_id]'
```

**Watch mode** — continuously poll a feed and stream NDJSON (one JSON object per line):

```bash
# Poll every 30 seconds
gtfs-cli fetch --watch 30 "https://gtfsrt.ttc.ca/trips/update?format=binary"

# Count entities on each snapshot
gtfs-cli fetch --watch 30 "https://gtfsrt.ttc.ca/trips/update?format=binary" \
  | jq --unbuffered '.entity | length'

# Save a long-running collection to a file
gtfs-cli fetch --watch 30 "https://gtfsrt.ttc.ca/trips/update?format=binary" \
  >> snapshots.ndjson
```

Watch mode handles transient failures gracefully: HTTP and network errors are retried with exponential backoff (1s → 2s → 4s … capped at 60s). Stop with `Ctrl+C` or `SIGTERM`.

For all available options, run:

```bash
gtfs-cli fetch --help
```

## Development

```bash
# Install dependencies
uv sync

# Run a command
uv run gtfs-cli fetch "https://gtfsrt.ttc.ca/trips/update?format=binary"

# Run tests
uv run pytest tests/ -v
```
