# Koleo CLI
[](https://pypi.org/project/koleo-cli)
[](https://pypi.org/project/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
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
```
Raw data
{
"_id": null,
"home_page": "https://github.com/lzgirlcat/koleo-cli",
"name": "koleo-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": "cb98uzhd@duck.com",
"keywords": "koleo, timetable, trains, rail, poland",
"author": "Zoey !",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/5f/3f/6f6c41c6cf05864853eb42e61094ec1ec257a8bea94d864817994ff448d2/koleo_cli-0.2.137.11.tar.gz",
"platform": null,
"description": "# Koleo CLI\n[](https://pypi.org/project/koleo-cli)\n[](https://pypi.org/project/koleo-cli)\n\n## Installation\n**install via pip by running** `pip install koleo-cli`\n\n\n\n\n## it currently allows you to:\n - get departures/arrival list for a station\n - 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)\n - find a station or list all known stations\n - find a connection from station a to b, with filtering by operators\n - save a station as your favourite to quickly check it's departures\n\nadditionally you can also use the KoleoAPI wrapper directly in your own projects, all returns are fully typed using `typing.TypedDict`\n\n## MY(possibly controversial) design choices:\n - platforms and track numbers are shown using arabic numerals instead of roman\n - you can change it by adding `use_roman_numerals: true` to your config.json file\n - most api queries are cached for 24h\n - you can change it by adding `disable_cache: true` to your config.json file\n - the cli.py code is really dirty but printing formatted data is hard :<\n\npull requests are welcome!!\n\n```\nusage: koleo [-h] [-c CONFIG] [--nocolor] {departures,d,dep,odjazdy,o,arrivals,a,arr,przyjazdy,p,trainroute,r,tr,t,poc,poci\u0105g,stations,s,find,f,stacje,ls,connections,do,z,szukaj,path} ...\n\nKoleo CLI\n\noptions:\n -h, --help show this help message and exit\n -c CONFIG, --config CONFIG\n Custom config path.\n --nocolor Disable color output and formatting\n\nactions:\n {departures,d,dep,odjazdy,o,arrivals,a,arr,przyjazdy,p,trainroute,r,tr,t,poc,poci\u0105g,stations,s,find,f,stacje,ls,connections,do,z,szukaj,path}\n departures (d, dep, odjazdy, o)\n Allows you to list station departures\n arrivals (a, arr, przyjazdy, p)\n Allows you to list station departures\n trainroute (r, tr, t, poc, poci\u0105g)\n Allows you to show the train's route\n stations (s, find, f, stacje, ls)\n Allows you to find stations by their name\n connections (do, z, szukaj, path)\n Allows you to search for connections from a to b\n```\n",
"bugtrack_url": null,
"license": "GNU General Public License v3.0",
"summary": "Koleo CLI",
"version": "0.2.137.11",
"project_urls": {
"Homepage": "https://github.com/lzgirlcat/koleo-cli",
"Issue Tracker": "https://github.com/lzgirlcat/koleo-cli/issues",
"Source (GitHub)": "https://github.com/lzgirlcat/koleo-cli"
},
"split_keywords": [
"koleo",
" timetable",
" trains",
" rail",
" poland"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f287f2e3c5ed3a08517f4db65684611e160ed5df4d8f57ae25a402876ab79f5a",
"md5": "6fe06f820070dae5ce3ad2f99b98b93c",
"sha256": "7bdb28e89f50a101b757d49625ce88d055ac10949afd1ed2800906b334d1bf35"
},
"downloads": -1,
"filename": "koleo_cli-0.2.137.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6fe06f820070dae5ce3ad2f99b98b93c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 25520,
"upload_time": "2024-11-10T14:52:42",
"upload_time_iso_8601": "2024-11-10T14:52:42.909677Z",
"url": "https://files.pythonhosted.org/packages/f2/87/f2e3c5ed3a08517f4db65684611e160ed5df4d8f57ae25a402876ab79f5a/koleo_cli-0.2.137.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5f3f6f6c41c6cf05864853eb42e61094ec1ec257a8bea94d864817994ff448d2",
"md5": "7fdd537c735d4e36920853df3645d261",
"sha256": "92640681fcf9b1aedce2cca5c13d753bc69495ccfc055eba4e1da3fa88c8ed86"
},
"downloads": -1,
"filename": "koleo_cli-0.2.137.11.tar.gz",
"has_sig": false,
"md5_digest": "7fdd537c735d4e36920853df3645d261",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 25986,
"upload_time": "2024-11-10T14:52:44",
"upload_time_iso_8601": "2024-11-10T14:52:44.425931Z",
"url": "https://files.pythonhosted.org/packages/5f/3f/6f6c41c6cf05864853eb42e61094ec1ec257a8bea94d864817994ff448d2/koleo_cli-0.2.137.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-10 14:52:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lzgirlcat",
"github_project": "koleo-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "koleo-cli"
}
JSON
