Skip to main content

Koleo CLI

Project description

PyPI - Version PyPI - Python Version

Koleo CLI

gif showcasing the functionality

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

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: true to your config.json file
  • most api queries are cached for 24h
    • you can change it by adding disable_cache: true to your config.json file
  • the cli.py code is really dirty but printing formatted data is hard :<

pull requests are welcome!!

usage: koleo [-h] [-c CONFIG] [--nocolor] {departures,d,dep,odjazdy,o,arrivals,a,arr,przyjazdy,p,trainroute,r,tr,t,poc,pociąg,stations,s,find,f,stacje,ls,connections,do,z,szukaj,path} ...

Koleo CLI

options:
  -h, --help            show this help message and exit
  -c CONFIG, --config CONFIG
                        Custom config path.
  --nocolor             Disable color output and formatting

actions:
  {departures,d,dep,odjazdy,o,arrivals,a,arr,przyjazdy,p,trainroute,r,tr,t,poc,pociąg,stations,s,find,f,stacje,ls,connections,do,z,szukaj,path}
    departures (d, dep, odjazdy, o)
                        Allows you to list station departures
    arrivals (a, arr, przyjazdy, p)
                        Allows you to list station departures
    trainroute (r, tr, t, poc, pociąg)
                        Allows you to show the train's route
    stations (s, find, f, stacje, ls)
                        Allows you to find stations by their name
    connections (do, z, szukaj, path)
                        Allows you to search for connections from a to b

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

koleo_cli-0.2.137.6.tar.gz (12.8 kB view details)

Uploaded Source

Built Distribution

koleo_cli-0.2.137.6-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file koleo_cli-0.2.137.6.tar.gz.

File metadata

  • Download URL: koleo_cli-0.2.137.6.tar.gz
  • Upload date:
  • Size: 12.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for koleo_cli-0.2.137.6.tar.gz
Algorithm Hash digest
SHA256 75cf9781f89ef9b90622cc42fb50de0eaaac703909d950145734c948f7a58f81
MD5 d57ea84cdea924b4887bc3f86b93d70c
BLAKE2b-256 6e782c6e0d6c1c456c62c4e7fac745e009a86d894815c4f5ef57af4141c4dd59

See more details on using hashes here.

File details

Details for the file koleo_cli-0.2.137.6-py3-none-any.whl.

File metadata

File hashes

Hashes for koleo_cli-0.2.137.6-py3-none-any.whl
Algorithm Hash digest
SHA256 e68b7dd1ae2ab701b4200a81ad79a055c1d8f848d3088cefcfec04c80ebf206e
MD5 b14a5a7acd0b45e0bffd32c1fccd6b7c
BLAKE2b-256 a53d522afef78169174720fdc5a6b3f65ab28e55eb4bf0d0b61275d193e2698d

See more details on using hashes here.

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