Skip to main content

Turn GTFS schedules into calendar events

Project description

transical

PyPI

transical converts publically-available GTFS transit schedules into calendar events, bundled into iCalendar (.ics) files.

It’s designed to automate putting public transit schedules in your calendar. iCalendar files can be imported into Google Calendar, Apple Calendar, Evolution, Thunderbird, or just about any other calendar application.

installing

pipx is the preferred way to install transical. Unlike pip alone: it automatically isolates the package from your other Python packages, puts the package in your PATH, and installs manpages.

On pipx systems:

pipx install transical

Install shell autocompletions with transical --autocomplete.

do you really want to use pip?

pip is not recommended. On pip systems, for global installation:

pip install transical

usage

transical input.gtfs 2026-07-01/2026-08-01 output.ics

That's it! transical interactively walks you through picking a route, origin stop, and destination stop, before producing an output file with all the transit journeys that fall between the specified dates (1 July and 1 August 2026, in this example).

$ transical https://feeds.mta.maryland.gov/gtfs/marc 2026-07-01/2026-08-01 output.ics
No route was provided. Use arrow keys to select a route from the menu below.
🔄› 11704 · MARC · BRUNSWICK - WASHINGTON                                       
    11705 · MARC · PENN - WASHINGTON                                            
    11706 · MARC · CAMDEN - WASHINGTON                                          
Selecting route. Hit </> to search.

You can directly import transical's .ics outputs in desktop applications (guides linked) like Google Calendar, Apple Calendar, Evolution, and Thunderbird.

You can also send outputs to yourself to import events on another device, with a tool like xdg-email:

xdg-email --attach output.ics recipient@example.com

more features

transical supports adding event reminders, and it even has its own filtering language to let you granularly choose journeys based on time of day and day of week.

transical has a noninteractive, script mode, too; it won't output anything it doesn't need to when called with --route and --termini flags already provided to it.

Read more about using transical or writing filter expressions. You can also find this documentation in transical's manpages, or see an overview with transical --help.

developing and building

This project uses uv.

Clone the repository with Git and use uv to install dependencies:

git clone git@github.com:solanto/transical.git
cd transical
uv sync

Run the program in development with uv run:

uv run transical

And build the package with uv build:

uv build

This not only packages the program itself, but also converts documentation in docs to manpages—installable via pipx—by way of a custom Pandoc pipeline. You can check out this pipeline in tools.

acknowledgements

komoot's free photon API for OpenStreetMap lets this project make station names prettier in your calendar. Thanks, komoot!

contributing

Feel free to ask questions or make suggestions here or at person@dandelion.computer. I'll do my best to collaborate with those who'd like to!

If you fork transical, be sure to change meta:ORG_DOMAIN to your own domain (which could even be something like your-username.github.io). transical uses this identifier to tell remote servers exactly whose code is requesting information, as well as to document exactly whose code made the events in produced iCalendar files.

license

GNU General Public License v3.0 or later. See license in LICENSE.md.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

transical-0.2.tar.gz (28.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

transical-0.2-py3-none-any.whl (29.4 kB view details)

Uploaded Python 3

File details

Details for the file transical-0.2.tar.gz.

File metadata

  • Download URL: transical-0.2.tar.gz
  • Upload date:
  • Size: 28.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.24 {"installer":{"name":"uv","version":"0.11.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"openSUSE Tumbleweed","version":"20260623","id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for transical-0.2.tar.gz
Algorithm Hash digest
SHA256 f3222026b95a53fb46b015294443368008a66d7afeaf4e73675b24c3bb1204c0
MD5 17e1f3bff8960b6e8e86efd75462c1ce
BLAKE2b-256 47628dbb6997c3acf64c00d338981fbd42cd958709616b859eb304f10cd75d04

See more details on using hashes here.

File details

Details for the file transical-0.2-py3-none-any.whl.

File metadata

  • Download URL: transical-0.2-py3-none-any.whl
  • Upload date:
  • Size: 29.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.24 {"installer":{"name":"uv","version":"0.11.24","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"openSUSE Tumbleweed","version":"20260623","id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for transical-0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b5a43212ff30581f36a3587efac4966c3535b5e9c0b0ca22e7d4b7630aa95284
MD5 492d6f297495fcb99d7809b0be79d7ca
BLAKE2b-256 64e43441ade9ef796d3df31edc0fb43181d4ab34ab390a1de0e2f9ee6a6b0752

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page