Skip to content

Repository files navigation

CICD

Renfe Timetables CLI

Get faster Renfe trains timetables in your terminal, with Python 3.10+ support. No longer need to open the browser! Just keep using your terminal 😀

It supports both Horarios de alta velocidad, larga distancia y media distancia (default option, as in the web) and Renfe Cercanías GTFS datasets. Timetable searches include connections with up to three transfers. The router favors shorter journeys and applies a transfer penalty so a marginal time saving does not produce an unnecessarily complicated itinerary.

renfe-cli is written in Rust (since v4.0.0) and published to pypi.org as a Python package (CLI and library).

It is provided as a Python package due to historical reasons, but was ported to Rust to showcase Rust's interoperability and performance improvements that can offer to the Python ecosystem. Nevertheless, one can optionally use the built renfe-cli crate that is publised to crates.io.

See the changelog.

NOTE since I am more often using Rodalies trains I have created rodalies-cli. I hope you like it too!

DISCLAIMER: Renfe's GTFS dataset might not be in sync with autonomic train schedules systems (e.g. Rodalies de la Generalitat de Catalunya), hence Renfe Cercanias train types (e.g.: REGIONAL or MD type) might not be accurate, or when using the cercanias flag you won't find timetables for the stations belonging to autonomic systems. For that, please use autonomic data/apps (.e.g: rodalies-cli).

Installation

Python package

Install Python CLI package renfe-cli

uv tool install renfe-cli --upgrade

Rust crate (optional)

Install the Rust crate renfe-cli

cargo install renfe-cli

Usage (CLI)

The CLI uses the official and latest Renfe's GTFS dataset, from Horarios de alta velocidad, larga distancia y media distancia, by default. Optionally, one can enable searching over Renfe Cercanías GTFS dataset (expect longer load time in this case).

$ renfe-cli -h
Usage: renfe-cli [options]

Options:
    -f ORIGIN           Set From origin station
    -t DESTINATION      Set To destination station
    -d, --day DAY       Set the Day (default: today's day)
    -m, --month MONTH   Set the Month (default: today's month)
    -y, --year YEAR     Set the Year (default: today's year)
    -s, --sort          Option to sort the timetable by Duration
    -c, --cercanias     Option to search over Renfe Cercanías
    -h, --help          Print this help menu

Getting the timetable

Let's show an example of minimal inputs (origin and destination stations) with specific date and default GTFS dataset:

$ renfe-cli  -f girona -t "puerta de atocha" -d 30
Loading default GTFS data from Renfe web - Alta velocidad, Larga distancia y Media distancia
Today is: 2024-9-29
Searching timetable for date: 2024-9-30
Origin station: Estación de tren Girona
Destination station: Estación de tren Madrid-Puerta de Atocha

=========================TIMETABLE=========================
  Train        |   Departure  |   Arrival    |   Duration
-----------------------------------------------------------
   AVLO        |    05:46     |    09:20     |    03:34
-----------------------------------------------------------
   AVE         |    06:41     |    10:10     |    03:29
-----------------------------------------------------------
   AVE         |    08:11     |    11:45     |    03:34
-----------------------------------------------------------
   AVE INT     |    11:59     |    15:45     |    03:46
-----------------------------------------------------------
   AVE         |    15:11     |    19:12     |    04:01
-----------------------------------------------------------
   AVE         |    17:51     |    21:45     |    03:54
===========================================================

Let's show an example using Renfe Cercanías GTFS dataset:

$ renfe-cli -f chamartín -t "tres cantos" -c
Loading Cercanías GTFS data from Renfe web - long load time
Today is: 2024-10-2
Searching timetable for date: 2024-10-2
Origin station: Estación de tren Madrid-Chamartín-Clara Campoamor
Destination station: Estación de tren Tres Cantos (apt)

=========================TIMETABLE=========================
  Train        |   Departure  |   Arrival    |   Duration    
-----------------------------------------------------------
   C4b         |    05:06     |    05:22     |    00:16     
-----------------------------------------------------------
   C4b         |    05:38     |    05:55     |    00:17     
-----------------------------------------------------------
   C4b         |    06:10     |    06:27     |    00:17     
-----------------------------------------------------------
.........
.........
-----------------------------------------------------------
   C4b         |    21:56     |    22:13     |    00:17     
-----------------------------------------------------------
   C4b         |    22:20     |    22:37     |    00:17     
-----------------------------------------------------------
   C4b         |    23:16     |    23:33     |    00:17     
===========================================================

Selecting a station

Station names are matched case-insensitively and may be abbreviated. If the provided text matches more than one station, the CLI sorts the matches by name and asks which station to use. Select it by entering its 1-based ordinal number:

$ renfe-cli -f madrid -t girona
Multiple stations match 'madrid':
  1. Estación de tren Madrid - Atocha Cercanias
  2. Estación de tren Madrid-Chamartin
  3. Estación de tren Madrid-Nuevos Ministerios
  4. Estación de tren Madrid-Principe Pio
  5. Estación de tren Madrid-Puerta de Atocha
  6. Estación de tren Madrid-Ramon Y Cajal
  7. Estación de tren Madrid-Recoletos
Select a station [1-7]: 5

Invalid numbers are rejected and the CLI asks again. If the provided text does not match any station, it reports the input without presenting a selection:

ValueError: Provided input 'unknown' does not match any station name

Journeys with connections include the details of every transfer directly below the timetable row. The arrival and departure are the times at which the transfer starts and ends; the duration is the total time available to change trains. Transfers between different stops show both station names:

      Transfer 1 at Madrid-Chamartín: arrive 10:05, depart 10:20 (00:15)
      Transfer 2 at Madrid-Atocha → Madrid-Puerta de Atocha: arrive 10:45, depart 11:10 (00:25)

Downloaded feeds are converted to routing data and cached in the operating system's user cache directory. On later runs, renfe-cli sends Renfe the stored HTTP ETag; when the feed has not changed, Renfe returns 304 Not Modified and the processed data is loaded directly from the local cache. Set RENFE_CLI_CACHE_DIR to use a custom cache location.

Usage (Library)

renfe-cli can be imported as a python package into your project, offering utilities when willing to deal with the Renfe search web site.

$ python
Python 3.12.6 (main, Sep  8 2024, 13:18:56) [GCC 14.2.1 20240805] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import renfe_cli
>>> renfe = renfe_cli.
renfe_cli.Renfe()    renfe_cli.Schedule(  renfe_cli.Station(   renfe_cli.main()     renfe_cli.renfe_cli  
>>> renfe = renfe_cli.Renfe()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: Renfe.__new__() missing 1 required positional argument: 'cercanias'
>>> renfe = renfe_cli.Renfe(False)
Loading default GTFS data from Renfe web - Alta velocidad, Larga distancia y Media distancia
GTFS data:
  Read in 2171 ms
  Stops: 793
  Routes: 644
  Trips: 4150
  Agencies: 1
  Shapes: 0
  Fare attributes: 0
  Feed info: 0
>>> len(renfe.stations_match("madrid"))
7
>>> len(renfe.stations_match("girona"))
1
>>> renfe.print_timetable()

No schedules available...won't print timetable.
>>> renfe.set_train_schedules("79300", "60000", 30, 9, 2024, False)
>>> renfe.print_timetable()

=========================TIMETABLE=========================
  Train        |   Departure  |   Arrival    |   Duration
-----------------------------------------------------------
   AVLO        |    05:46     |    09:20     |    03:34
-----------------------------------------------------------
   AVE         |    06:41     |    10:10     |    03:29
-----------------------------------------------------------
   AVE         |    08:11     |    11:45     |    03:34
-----------------------------------------------------------
   AVE INT     |    11:59     |    15:45     |    03:46
-----------------------------------------------------------
   AVE         |    15:11     |    19:12     |    04:01
-----------------------------------------------------------
   AVE         |    17:51     |    21:45     |    03:54
===========================================================
>>> ...

Contribute or Report with Issues

If Renfe's GTFS dataset is being kept not up to date or you find any issue to be fixed or nice enhancements to have, please: create an issue.

Development

This project uses Rust bindings for the Python interpreter through PyO3 and Maturin to build and install the Python package.

Install uv first, then set up a development environment:

git clone https://github.com/gerardcl/renfe-cli.git
cd renfe-cli
uv python install 3.10
uv venv --python 3.10
source .venv/bin/activate
uvx maturin develop --uv

Maturin compiles the Rust code, generates the Python bindings, and installs the package into .venv for local use as a library or CLI. After changing Rust code, run uvx maturin develop --uv again to rebuild it. Use uv run renfe-cli --help to run the development installation.

About

Python CLI written in Rust for fast Renfe search website trains timetables retrieval

Topics

Resources

Stars

47 stars

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages