renfe-bot

KO | EN

gitlite — search

#javascript #python #react #typescript #llm #golang #go #macos #nodejs #awesome #vue #security #ios #mcp

(★ 26)

Renfe-bot es un bot de Telegram + scraper que te ayudará a buscar billetes, especialmente útil cuando están agotados y dependen de la cancelación de otros usuarios

renfe-bot Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# renfe-bot
[![CI](https://github.com/emartinez-dev/renfe-bot/actions/workflows/ci.yml/badge.svg)](https://github.com/emartinez-dev/renfe-bot/actions/workflows/ci.yml)
[![Nightly Tests](https://github.com/emartinez-dev/renfe-bot/actions/workflows/nightly-tests.yml/badge.svg)](https://github.com/emartinez-dev/renfe-bot/actions/workflows/nightly-tests.yml)
![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Femartinez-dev%2Frenfe-bot%2Fmaster%2Fpyproject.toml)
[![codecov](https://codecov.io/gh/emartinez-dev/renfe-bot/graph/badge.svg?token=L39OAEL5MD)](https://codecov.io/gh/emartinez-dev/renfe-bot)
![license](https://img.shields.io/github/license/emartinez-dev/renfe-bot.svg)

| Python Version Support | Supported Platforms |
|-------------------------|---------------------|
| ![Python >= 3.12](https://img.shields.io/badge/python-%3E%3D%203.12-blue.svg) | ![Linux](https://img.shields.io/badge/platform-Linux-blue.svg) ![macOS](https://img.shields.io/badge/platform-macOS-lightgrey.svg) ![Windows](https://img.shields.io/badge/platform-Windows-brightgreen.svg) |

_También puedes leer esto en [Español](https://github.com/emartinez-dev/renfe-bot/blob/master/docs/README_es.md)_

## Description

Renfe-bot is a Telegram bot designed to assist users in purchasing train tickets
from Renfe, the main railway operator in Spain. The bot monitors ticket
availability, especially in situations when tickets are sold out and only become
available when someone cancels their reservation. It promptly notifies users
when there are tickets available for purchase. The bot now supports a Telegram
chatbot interface for enhanced user interaction.

New in v0.3.0: Renfe‑bot now ships with a lightweight command‑line interface
(CLI) so you can perform quick one‑off searches directly from your terminal —
perfect for scripting or when you don’t want to open Telegram.

The error handling is not perfect, so if you encounter any issues, retrying the
command should work. If the issue persists, please open an issue on GitHub.

## How to run

### Option A: Running normally in your computer

#### Requirements

This project requires at least Python 3.12, and it runs on macOS, Linux and
Windows.

#### Installation

Follow the below steps to install and set up the Renfe-bot:

Clone this repository to your local machine or download the code
```bash
git clone git@github.com:emartinez-dev/renfe-bot.git
```

Install the required dependencies using the following command
```bash
pip install -r requirements.txt
```

Run the bot by executing it with this command

```bash
PYTHONPATH=src/ python src/bot.py
```

or this one if you are on Windows command prompt

```bash
setx PYTHONPATH src/
python src/bot.py
```

Anything required like the API key will be prompted for when you run the bot   for the first time.

### Option B: Running it as a Docker container

#### Requirements

To run this in Docker, you will just need to have a valid installation of Docker,
everything else is provided in the Dockerfile.

> [!IMPORTANT]
> It's possible that you need to add `sudo` before every command,
> or you can add your user to the `docker` group, check [this
> doc](https://docs.docker.com/engine/install/linux-postinstall/).

#### Installation

First you need to build the image, do it with the following command:

```bash
docker build -t renfe-bot .
```

When the image finishes building, it can already be run with the following command:

```bash
docker run -it -v $(pwd):/app renfe-bot
```

Or if you are using Windows:

```bat
docker run -it -v %cd%:/app renfe-bot
```

### Option C: Using the command‑line interface (CLI)

The CLI offers the fastest way to look up trains straight from your shell.

#### Quick start

Once the project’s dependencies are installed (see **Option A – Installation** above), you can run
the CLI program with the following syntax:

```bash
PYTHONPATH=./src python src/cli.py -o <ORIGIN> -d <DESTINATION> --departure_date DD/MM/YYYY
```

Example:

```bash
PYTHONPATH=./src python src/cli.py -o Madrid -d Barcelona --departure_date 21/06/2025
```

The command prints a table like this:

```
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃          Trains from Madrid to Barcelona – 21/06/2025        ┃
┡━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━┯━━━━━━━━━┯━━━━━━━┩
│ Train type   │ Departure    │ Arrival      │ Duration │ Price │
├──────────────┼──────────────┼──────────────┼─────────┼───────┤
│ AVE          │ 06:30        │ 08:59        │ 2.5 h.   │ 46.90€│
│ AVE          │ 07:30        │ 10:05        │ 2.6 h.   │ 38.15€│ ← cheaper‑than‑avg highlighted in green
└──────────────┴──────────────┴──────────────┴─────────┴───────┘
```

#### Arguments

* **`-o, --origin`** (required) – Origin station name.
* **`-d, --destination`** (required) – Destination station name.
* **`--departure_date`** (required) – Date of travel in `DD/MM/YYYY` format.

## Usage

### Bot

To use the bot, send a message to your bot on Telegram. You need to provide
inputs such as origin and destination stations, and dates. The bot will monitor
the ticket availability and notify you immediately when there's a ticket
available for your journey.

### CLI

See Option C above.

## Contributing

This project is open source and contributions are very much welcomed. If you
would like to contribute to the project, please follow these steps:

1. Fork the repository.
2. Create a new branch for your changes.
3. Make your changes.
4. Push your changes to your fork.
5. Submit a pull request with a description of the changes.

Before merging, all changes will be tested to ensure they function correctly.
Contributions are not limited to code changes; opening issues or providing
suggestions are equally valuable.

## License

This project is licensed under the terms of the [MIT
License](https://opensource.org/license/mit/).

The MIT License is a permissive license that allows for reuse of software within
proprietary software provided that all copies of the licensed software include a
copy of the MIT License terms and the copyright notice.

This means that you are free to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the software, as long as you include the
necessary attribution and provide a copy of the MIT license.

You can see the full license text in the LICENSE file.

renfe-bot

renfe-bot Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

renfe-bot

renfe-bot Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README