Koleo CLI
Project description
Koleo CLI
Installation
install via pip by running pip install koleo-cli
it currently allows you to:
- get departures/arrival list for a station
- get train info given its number and name(pull requests are welcome if you know how to get a train object by just the number)
- find a station or list all known stations
- find a connection from station a to b, with filtering by operators
- save a station as your favourite to quickly check it's departures
- add station aliases to query them more easily
- check seat allocation statistics
coming soon™️:
- TUI ticket purchase interface
- ticket display
- your previous tickets + stats
- find empty compartments
additionally you can also use the KoleoAPI wrapper directly in your own projects, all returns are fully typed using
typing.TypedDict
MY(possibly controversial) design choices:
- platforms and track numbers are shown using arabic numerals instead of roman
- you can change it by adding
use_roman_numerals: trueto yourkoleo-cli.jsonconfig file
- you can change it by adding
- most api queries are cached for 24h
- you can change it by adding
disable_cache: trueto yourkoleo-cli.jsonconfig file
- you can change it by adding
- stations/ls uses emojis by default
- you can disable them by adding
use_country_flags_emoji: falseanduse_country_flags_emoji: falseto yourkoleo-cli.jsonconfig file pull requests are welcome!!
- you can disable them by adding
usage: koleo [-h] [-c CONFIG] [--nocolor]
{departures,d,dep,odjazdy,o,arrivals,a,arr,przyjazdy,p,all,w,wszystkie,all_trains,pociagi,trainroute,r,tr,t,poc,pociąg,traincalendar,kursowanie,tc,k,traindetail,td,tid,id,idpoc,stations,s,find,f,stacje,ls,q,connections,do,z,szukaj,path,trainstats,ts,tp,miejsca,frekwencja,trainconnectionstats,tcs,aliases} ...
Koleo CLI
options:
-h, --help show this help message and exit
-c, --config CONFIG Custom config path.
--nocolor Disable color output and formatting
actions:
{departures,d,dep,odjazdy,o,arrivals,a,arr,przyjazdy,p,all,w,wszystkie,all_trains,pociagi,trainroute,r,tr,t,poc,pociąg,traincalendar,kursowanie,tc,k,traindetail,td,tid,id,idpoc,stations,s,find,f,stacje,ls,q,connections,do,z,szukaj,path,trainstats,ts,tp,miejsca,frekwencja,trainconnectionstats,tcs,aliases}
departures (d, dep, odjazdy, o)
Allows you to list station departures
arrivals (a, arr, przyjazdy, p)
Allows you to list station departures
all (w, wszystkie, all_trains, pociagi)
Allows you to list all station trains
trainroute (r, tr, t, poc, pociąg)
Allows you to check the train's route
traincalendar (kursowanie, tc, k)
Allows you to check what days the train runs on
traindetail (td, tid, id, idpoc)
Allows you to show the train's route given it's koleo ID
stations (s, find, f, stacje, ls, q)
Allows you to find stations by their name
connections (do, z, szukaj, path)
Allows you to search for connections from a to b
trainstats (ts, tp, miejsca, frekwencja)
Allows you to check seat allocation info for a train.
trainconnectionstats (tcs)
Allows you to check the seat allocations on the train connection given it's koleo ID
aliases Save quick aliases for station names!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
koleo_cli-0.2.137.29.tar.gz
(40.6 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file koleo_cli-0.2.137.29.tar.gz.
File metadata
- Download URL: koleo_cli-0.2.137.29.tar.gz
- Upload date:
- Size: 40.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.25
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4b8005d1fe3e9011a57c601204b0d4b4b77255d42978c5e16d22f41a7a7afbd6
|
|
| MD5 |
5149445e8df01b15214dfef83c54685b
|
|
| BLAKE2b-256 |
b368aa01a3b45eac609f957e730fc0f0e19d01170edf353ce4c4ada8d25f8b27
|
File details
Details for the file koleo_cli-0.2.137.29-py3-none-any.whl.
File metadata
- Download URL: koleo_cli-0.2.137.29-py3-none-any.whl
- Upload date:
- Size: 43.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.25
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7daff2be93faffba451f437a5de29f8395627905a0c5cfbbd5615136f36649fc
|
|
| MD5 |
2bd57385c80445e02cd9d5ae55eb95f2
|
|
| BLAKE2b-256 |
10a2c1e9a9630b42524252ea86e054ea984f012e3bc7e952f7c22fa31066f95a
|