Metadata-Version: 2.1
Name: clirail
Version: 1.0
Summary: Command line application for the iRail API
Home-page: https://framagit.org/Midgard/clirail/
Author: Midgard
License: UNKNOWN
Project-URL: Bug Tracker, https://framagit.org/Midgard/clirail/-/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Natural Language :: Dutch
Classifier: Environment :: Console
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: End Users/Desktop
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: requests
Requires-Dist: python-dateutil

# clirail

Command line application for the iRail API

iRail provides an API for Belgian trains.

## Installation
```
pip install clirail
```

## Usage
Stations can be identified by name or by telegraphic code. You can learn telegraphic codes by
looking at a liveboard in clirail, or looking at stations' Wikipedia articles.

### Liveboard
A list of the trains departing shortly in a station.
* `./clirail STATION`: departing ASAP
* `./clirail STATION '' DEPARTURE_MOMENT`: departing at another moment

### Route planning
* `./clirail FROM_STATION TO_STATION`: departing ASAP
* `./clirail FROM_STATION TO_STATION DEPARTURE_MOMENT`: departing at another moment

### Disturbances
A list of all recent disturbances on the network.
* `./clirail`

## Licenses
* clirail code is released under GNU GPLv3+.
* xdg is released under ISC.

## Known issues
* Provided dates will be today, even though in some cases it makes more sense to consider it
  "tomorrow" (e.g. at 11 PM planning a route with departure at 7 AM)
* No help text yet

## Development
To create a virtualenv and install the dependencies in it:
```
tools/create_venv.py
```

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


