Skip to main content

Command line application for the iRail API

Project description

clirail

Command line application for the iRail API

iRail provides an API for Belgian trains.

Installation

pip install --user --upgrade clirail

Then make sure the installed executable will be found. On UNIX-like systems, this means checking that ~/.local/bin/ is in your PATH.

Usage

Command Function
clirail ['' ] Liveboard (list of trains departing in station)
clirail <from_station> <to_station> [] Route planning
clirail Analyse current timeliness in a few stations

Omit the <moment> for ASAP departures.

Give either the name or the telegraphic code. Names are matched fuzzily and intuitively. You can learn telegraphic codes by looking at a liveboard in clirail.

Licenses

  • clirail code is released under GNU GPLv3+.
  • xdg is released under ISC.

Known issues

  • If <moment> is just a time, it will be considered as today, even though in some cases it would make more sense to consider it as tomorrow (e.g. at 11 PM planning a route with departure at 7 AM).

Development

To create a virtualenv and install the dependencies in it:

tools/create_venv.py

Activate the virtualenv with source venv/bin/activate. Then run bin/clirail to run the program.

Important: make sure the virtualenv is activated each time you run, otherwise your global clirail installation may be used.

If you introduce dependencies, list them in setup.py under install_requires, and run tools/update_requirements.sh.

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

clirail-1.1.tar.gz (29.4 kB view hashes)

Uploaded Source

Built Distribution

clirail-1.1-py3-none-any.whl (27.0 kB view hashes)

Uploaded Python 3

Supported by

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