koleo-cli 0.2.137.4__tar.gz → 0.2.137.6__tar.gz

koleo_cli-0.2.137.6/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.1
+Name: koleo-cli
+Version: 0.2.137.6
+Summary: Koleo CLI
+Home-page: https://github.com/lzgirlcat/koleo-cli
+Author: Zoey !
+Maintainer-email: cb98uzhd@duck.com
+License: GNU General Public License v3.0
+Project-URL: Source (GitHub), https://github.com/lzgirlcat/koleo-cli
+Project-URL: Issue Tracker, https://github.com/lzgirlcat/koleo-cli/issues
+Keywords: koleo,timetable,trains,rail,poland
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: rich==13.7.1
+Requires-Dist: requests==2.31.0
+
+[![PyPI - Version](https://img.shields.io/pypi/v/koleo-cli.svg)](https://pypi.org/project/koleo-cli)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/koleo-cli.svg)](https://pypi.org/project/koleo-cli)
+
+# Koleo CLI
+
+![gif showcasing the functionality](https://github.com/lzgirlcat/koleo-cli/blob/main/koleo-cli.gif?raw=true)
+
+
+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
+```

koleo_cli-0.2.137.6/README.md

@@ -0,0 +1,54 @@
+[![PyPI - Version](https://img.shields.io/pypi/v/koleo-cli.svg)](https://pypi.org/project/koleo-cli)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/koleo-cli.svg)](https://pypi.org/project/koleo-cli)
+
+# Koleo CLI
+
+![gif showcasing the functionality](https://github.com/lzgirlcat/koleo-cli/blob/main/koleo-cli.gif?raw=true)
+
+
+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
+```

{koleo_cli-0.2.137.4 → koleo_cli-0.2.137.6}/koleo/api.py

@@ -37,11 +37,9 @@ class errors:
     class KoleoForbidden(KoleoAPIException):
         pass
 
-
     class KoleoUnauthorized(KoleoAPIException):
         pass
 
-
     class KoleoRatelimited(KoleoAPIException):
         pass
 

{koleo_cli-0.2.137.4 → koleo_cli-0.2.137.6}/koleo/cli.py

@@ -7,11 +7,11 @@ from rich.traceback import install
 
 from .api import KoleoAPI
 from .storage import DEFAULT_CONFIG_PATH, Storage
-from .types import TrainDetailResponse, TrainOnStationInfo, ExtendedBaseStationInfo
-from .utils import convert_platform_number, name_to_slug, parse_datetime, arr_dep_to_dt
+from .types import ExtendedBaseStationInfo, TrainDetailResponse, TrainOnStationInfo
+from .utils import RemainderString, arr_dep_to_dt, convert_platform_number, name_to_slug, parse_datetime
 
 
-install(show_locals=False, max_frames=2)
+install(show_locals=True, max_frames=2)
 
 
 class CLI:
@@ -28,7 +28,7 @@ class CLI:
 
     def print(self, text, *args, **kwargs):
         if self.no_color:
-            result = re.sub(r'\[[^\]]*\]', '', text)
+            result = re.sub(r"\[[^\]]*\]", "", text)
             print(result)
         else:
             self.console.print(text, *args, **kwargs)
@@ -55,9 +55,8 @@ class CLI:
 
     def get_departures(self, station_id: int, date: datetime):
         cache_id = f"dep-{station_id}-{date.strftime("%Y-%m-%d")}"
-        trains = (
-            self.storage.get_cache(cache_id) or
-            self.storage.set_cache(cache_id, self.client.get_departures(station_id, date))
+        trains = self.storage.get_cache(cache_id) or self.storage.set_cache(
+            cache_id, self.client.get_departures(station_id, date)
         )
         trains = [
             i
@@ -70,9 +69,8 @@ class CLI:
 
     def get_arrivals(self, station_id: int, date: datetime):
         cache_id = f"arr-{station_id}-{date.strftime("%Y-%m-%d")}"
-        trains = (
-            self.storage.get_cache(cache_id) or
-            self.storage.set_cache(cache_id, self.client.get_arrivals(station_id, date))
+        trains = self.storage.get_cache(cache_id) or self.storage.set_cache(
+            cache_id, self.client.get_arrivals(station_id, date)
         )
         trains = [
             i
@@ -99,22 +97,23 @@ class CLI:
         if query:
             stations = self.client.find_station(query)
         else:
-            stations = (
-                self.storage.get_cache("stations") or
-                self.storage.set_cache("stations", self.client.get_stations())
+            stations = self.storage.get_cache("stations") or self.storage.set_cache(
+                "stations", self.client.get_stations()
             )
         for st in stations:
-            self.print(f"[bold blue][link=https://koleo.pl/dworzec-pkp/{st["name_slug"]}]{st["name"]}[/bold blue] ID: {st["id"]}[/link]")
+            self.print(
+                f"[bold blue][link=https://koleo.pl/dworzec-pkp/{st["name_slug"]}]{st["name"]}[/bold blue] ID: {st["id"]}[/link]"
+            )
 
     def train_info(self, brand: str, name: str, date: datetime):
         brand = brand.upper().strip()
-        name = name.strip()
-        if name.isnumeric():
-            number = int(name)
+        name_parts = name.split(" ")
+        if len(name_parts) == 1 and name_parts[0].isnumeric():
+            number = int(name_parts[0])
             train_name = ""
-        elif len((parts := name.split(" "))) == 2 or len((parts := name.split("-"))) == 2:
-            number, train_name = parts
-            number = int(number)
+        elif len(name) > 1:
+            number = int(name_parts.pop(0))
+            train_name = " ".join(name_parts)
         else:
             raise ValueError("Invalid train name!")
         brands = self.storage.get_cache("brands") or self.storage.set_cache("brands", self.client.get_brands())
@@ -124,20 +123,28 @@ class CLI:
                 raise ValueError("Invalid brand name!")
             brand = res
         cache_id = f"tc-{brand}-{number}-{name}"
-        train_calendars = self.storage.get_cache(cache_id) or self.storage.set_cache(
-            cache_id, self.client.get_train_calendars(brand, number, train_name)
-        )
+        try:
+            train_calendars = self.storage.get_cache(cache_id) or self.storage.set_cache(
+                cache_id, self.client.get_train_calendars(brand, number, train_name)
+            )
+        except self.client.errors.KoleoNotFound:
+            self.print(f'[bold red]Train not found: nr={number}, name="{train_name}"[/bold red]')
+            exit(2)
         train_id = train_calendars["train_calendars"][0]["date_train_map"][date.strftime("%Y-%m-%d")]
         train_details = self.client.get_train(train_id)
         brand = next(iter(i for i in brands if i["id"] == train_details["train"]["brand_id"]), {}).get("logo_text", "")
         parts = [f"[red]{brand}[/red] [bold blue]{train_details["train"]["train_full_name"]}[/bold blue]"]
         route_start = arr_dep_to_dt(train_details["stops"][0]["departure"])
         route_end = arr_dep_to_dt(train_details["stops"][-1]["arrival"])
-        if route_end.hour < route_start.hour or (route_end.hour==route_start.hour and route_end.minute < route_end.minute):
+        if route_end.hour < route_start.hour or (
+            route_end.hour == route_start.hour and route_end.minute < route_end.minute
+        ):
             route_end += timedelta(days=1)
         travel_time = route_end - route_start
         speed = train_details["stops"][-1]["distance"] / 1000 / travel_time.seconds * 3600
-        parts.append(f"[white]  {travel_time.seconds//3600}h{(travel_time.seconds % 3600)/60:.0f}m {speed:^4.1f}km/h [/white]")
+        parts.append(
+            f"[white]  {travel_time.seconds//3600}h{(travel_time.seconds % 3600)/60:.0f}m {speed:^4.1f}km/h [/white]"
+        )
         vehicle_types: dict[str, str] = {
             stop["station_display_name"]: stop["vehicle_type"]
             for stop in train_details["stops"]
@@ -162,24 +169,27 @@ class CLI:
         if not brands:
             connection_brands = [i["id"] for i in api_brands]
         else:
-            connection_brands = [i["id"] for i in api_brands if i["name"].lower().strip() in brands or i["logo_text"].lower().strip() in brands]
+            connection_brands = [
+                i["id"]
+                for i in api_brands
+                if i["name"].lower().strip() in brands or i["logo_text"].lower().strip() in brands
+            ]
             if not connection_brands:
                 self.print(f'[bold red]No brands match: "{', '.join(brands)}"[/bold red]')
                 exit(2)
         connections = self.client.get_connections(
-            start_station["name_slug"],
-            end_station["name_slug"],
-            connection_brands,
-            date,
-            direct,
-            purchasable
+            start_station["name_slug"], end_station["name_slug"], connection_brands, date, direct, purchasable
         )
-        parts = [f"[bold blue]{start_station["name"]} → {end_station["name"]} at {date.strftime("%H:%M %d-%m")}[/bold blue]"]
+        parts = [
+            f"[bold blue]{start_station["name"]} → {end_station["name"]} at {date.strftime("%H:%M %d-%m")}[/bold blue]"
+        ]
         for i in connections:
             arr = arr_dep_to_dt(i["arrival"])
             dep = arr_dep_to_dt(i["departure"])
             travel_time = (arr - dep).seconds
-            parts.append(f"[bold green][link=https://koleo.pl/travel-options/{i["id"]}]{dep.strftime("%H:%M")} - {arr.strftime("%H:%M")}[/bold green] {travel_time//3600}h{(travel_time % 3600)/60:.0f}m {i['distance']}km: [/link]")
+            parts.append(
+                f"[bold green][link=https://koleo.pl/travel-options/{i["id"]}]{dep.strftime("%H:%M")} - {arr.strftime("%H:%M")}[/bold green] {travel_time//3600}h{(travel_time % 3600)/60:.0f}m {i['distance']}km: [/link]"
+            )
             if i["constriction_info"]:
                 for constriction in i["constriction_info"]:
                     parts.append(f" [bold red]- {constriction} [/bold red]")
@@ -187,14 +197,17 @@ class CLI:
                 train = i["trains"][0]
                 stop = next(iter(i for i in train["stops"] if i["station_id"] == train["start_station_id"]), {})
                 stop_station = (
-                    start_station if stop["station_id"] == start_station["id"] else
-                    self.storage.get_cache(f"st-{stop['station_id']}")
-                    or self.storage.set_cache(f"st-{stop['station_id']}", self.client.get_station_by_id(stop['station_id']))
+                    start_station
+                    if stop["station_id"] == start_station["id"]
+                    else self.storage.get_cache(f"st-{stop['station_id']}")
+                    or self.storage.set_cache(
+                        f"st-{stop['station_id']}", self.client.get_station_by_id(stop["station_id"])
+                    )
                 )
-                platform = convert_platform_number(stop["platform"]) if stop["platform"] else ""
-                position_info = f"{platform}/{stop["track"]}" if stop["track"] else platform
                 brand = next(iter(i for i in api_brands if i["id"] == train["brand_id"]), {}).get("logo_text")
-                parts[-1]+=f" [red]{brand}[/red] {train["train_full_name"]}[purple] {stop_station['name']} {position_info}[/purple]"
+                parts[-1] += (
+                    f" [red]{brand}[/red] {train["train_full_name"]}[purple] {stop_station['name']} {self.format_position(stop["platform"], stop["track"])}[/purple]"
+                )
             else:
                 previous_arrival: datetime | None = None
                 for train in i["trains"]:
@@ -202,29 +215,35 @@ class CLI:
 
                     fs = next(iter(i for i in train["stops"] if i["station_id"] == train["start_station_id"]), {})
                     fs_station = (
-                        start_station if fs["station_id"] == start_station["id"] else
-                        self.storage.get_cache(f"st-{fs['station_id']}")
-                        or self.storage.set_cache(f"st-{fs['station_id']}", self.client.get_station_by_id(fs['station_id']))
+                        start_station
+                        if fs["station_id"] == start_station["id"]
+                        else self.storage.get_cache(f"st-{fs['station_id']}")
+                        or self.storage.set_cache(
+                            f"st-{fs['station_id']}", self.client.get_station_by_id(fs["station_id"])
+                        )
                     )
-                    fs_platform = convert_platform_number(fs["platform"]) if fs["platform"] else ""
-                    fs_arr = arr_dep_to_dt(fs["arrival"])
+                    # fs_arr = arr_dep_to_dt(fs["arrival"])
                     fs_dep = arr_dep_to_dt(fs["departure"])
-                    fs_info = f"[bold green]{fs_dep.strftime("%H:%M")} [/bold green][purple]{fs_station['name']} {f"{fs_platform}/{fs["track"]}" if fs["track"] else fs_platform}[/purple]"
+                    fs_info = f"[bold green]{fs_dep.strftime("%H:%M")} [/bold green][purple]{fs_station['name']} {self.format_position(fs["platform"], fs["track"])}[/purple]"
 
                     ls = next(iter(i for i in train["stops"] if i["station_id"] == train["end_station_id"]), {})
                     ls_station = (
-                        start_station if ls["station_id"] == start_station["id"] else
-                        self.storage.get_cache(f"st-{ls['station_id']}")
-                        or self.storage.set_cache(f"st-{ls['station_id']}", self.client.get_station_by_id(ls['station_id']))
+                        start_station
+                        if ls["station_id"] == start_station["id"]
+                        else self.storage.get_cache(f"st-{ls['station_id']}")
+                        or self.storage.set_cache(
+                            f"st-{ls['station_id']}", self.client.get_station_by_id(ls["station_id"])
+                        )
                     )
-                    ls_platform = convert_platform_number(ls["platform"]) if ls["platform"] else ""
                     ls_arr = arr_dep_to_dt(ls["arrival"])
-                    ls_dep = arr_dep_to_dt(ls["departure"])
-                    ls_info = f"[bold green]{ls_arr.strftime("%H:%M")} [/bold green][purple]{ls_station['name']} {f"{ls_platform}/{ls["track"]}" if ls["track"] else ls_platform}[/purple]"
+                    # ls_dep = arr_dep_to_dt(ls["departure"])
+                    ls_info = f"[bold green]{ls_arr.strftime("%H:%M")} [/bold green][purple]{ls_station['name']} {self.format_position(ls["platform"], ls["track"])}[/purple]"
                     connection_time = (fs_dep - previous_arrival).seconds if previous_arrival else ""
                     previous_arrival = ls_arr
                     if connection_time:
-                        parts.append(f"  {connection_time//3600}h{(connection_time % 3600)/60:.0f}m at [purple]{fs_station['name']}[/purple]")
+                        parts.append(
+                            f"  {connection_time//3600}h{(connection_time % 3600)/60:.0f}m at [purple]{fs_station['name']}[/purple]"
+                        )
                     parts.append(f"  [red]{brand}[/red] {train["train_full_name"]} {fs_info} - {ls_info}")
         self.print("\n".join(parts))
 
@@ -235,10 +254,8 @@ class CLI:
             time = train["departure"] if type == 1 else train["arrival"]
             assert time
             brand = next(iter(i for i in brands if i["id"] == train["brand_id"]), {}).get("logo_text")
-            platform = convert_platform_number(train["platform"]) if train["platform"] else ""
-            position_info = f"{platform}/{train["track"]}" if train["track"] else platform
             parts.append(
-                f"[bold green]{time[11:16]}[/bold green] [red]{brand}[/red] {train["train_full_name"]}[purple] {train["stations"][0]["name"]} {position_info}[/purple]"
+                f"[bold green]{time[11:16]}[/bold green] [red]{brand}[/red] {train["train_full_name"]}[purple] {train["stations"][0]["name"]} {self.format_position(train["platform"], train["track"])}[/purple]"
             )
         return "\n".join(parts)
 
@@ -247,12 +264,17 @@ class CLI:
         for stop in train["stops"]:
             arr = arr_dep_to_dt(stop["arrival"])
             dep = arr_dep_to_dt(stop["departure"])
-            platform = convert_platform_number(stop["platform"]) or ""
             parts.append(
-                f"[white underline]{stop["distance"] / 1000:^5.1f}km[/white underline] [bold green]{arr.strftime("%H:%M")}[/bold green] - [bold red]{dep.strftime("%H:%M")}[/bold red] [purple]{stop["station_display_name"]} {platform} [/purple]"
+                f"[white underline]{stop["distance"] / 1000:^5.1f}km[/white underline] [bold green]{arr.strftime("%H:%M")}[/bold green] - [bold red]{dep.strftime("%H:%M")}[/bold red] [purple]{stop["station_display_name"]} {self.format_position(stop["platform"])} [/purple]"
             )
         return "\n".join(parts)
 
+    def format_position(self, platform: str, track: str | None = None):
+        res = str(convert_platform_number(platform)) or "" if not self.storage.use_roman_numerals else platform
+        if track is not None and track != "":
+            res += f"/{track}"
+        return res
+
     def get_station(self, station: str) -> ExtendedBaseStationInfo:
         slug = name_to_slug(station)
         try:
@@ -263,20 +285,24 @@ class CLI:
             self.print(f'[bold red]Station not found: "{station}"[/bold red]')
             exit(2)
 
+
 def main():
     cli = CLI()
 
     parser = ArgumentParser("koleo", description="Koleo CLI")
     parser.add_argument("-c", "--config", help="Custom config path.", default=DEFAULT_CONFIG_PATH)
-    parser.add_argument("--nocolor", help="Disable color output", action="store_true", default=False)
-    subparsers = parser.add_subparsers(title="actions", required=False) # type: ignore
+    parser.add_argument("--nocolor", help="Disable color output and formatting", action="store_true", default=False)
+    subparsers = parser.add_subparsers(title="actions", required=False)  # type: ignore
 
-    departures = subparsers.add_parser("departures", aliases=["d", "dep", "odjazdy", "o"], help="Allows you to list station departures")
+    departures = subparsers.add_parser(
+        "departures", aliases=["d", "dep", "odjazdy", "o"], help="Allows you to list station departures"
+    )
     departures.add_argument(
         "station",
         help="The station name",
         default=None,
-        nargs="?",
+        nargs="*",
+        action=RemainderString,
     )
     departures.add_argument(
         "-d",
@@ -288,12 +314,15 @@ def main():
     departures.add_argument("-s", "--save", help="save the station as your default one", action="store_true")
     departures.set_defaults(func=cli.full_departures, pass_=["station", "date"])
 
-    arrivals = subparsers.add_parser("arrivals", aliases=["a", "arr", "przyjazdy", "p"], help="Allows you to list station departures")
+    arrivals = subparsers.add_parser(
+        "arrivals", aliases=["a", "arr", "przyjazdy", "p"], help="Allows you to list station departures"
+    )
     arrivals.add_argument(
         "station",
         help="The station name",
         default=None,
-        nargs="?",
+        nargs="*",
+        action=RemainderString,
     )
     arrivals.add_argument(
         "-d",
@@ -311,7 +340,7 @@ def main():
         help="Allows you to show the train's route",
     )
     train_route.add_argument("brand", help="The brand name", type=str)
-    train_route.add_argument("name", help="The train name", type=str)
+    train_route.add_argument("name", help="The train name", nargs="+", action=RemainderString)
     train_route.add_argument(
         "-d",
         "--date",
@@ -321,12 +350,15 @@ def main():
     )
     train_route.set_defaults(func=cli.train_info, pass_=["brand", "name", "date"])
 
-    stations = subparsers.add_parser("stations", aliases=["s", "find", "f", "stacje", "ls"], help="Allows you to find stations by their name")
+    stations = subparsers.add_parser(
+        "stations", aliases=["s", "find", "f", "stacje", "ls", "q"], help="Allows you to find stations by their name"
+    )
     stations.add_argument(
         "query",
         help="The station name",
         default=None,
-        nargs="?",
+        nargs="*",
+        action=RemainderString,
     )
     stations.set_defaults(func=cli.find_station, pass_=["query"])
 
@@ -345,22 +377,21 @@ def main():
         default=datetime.now(),
     )
     connections.add_argument(
-        "-b",
-        "--brands",
-        help="Brands to include",
-        action="extend", nargs="+", type=str, default=[]
+        "-b", "--brands", help="Brands to include", action="extend", nargs="+", type=str, default=[]
     )
     connections.add_argument(
         "-f",
         "--direct",
         help="whether or not the result should only include direct trains",
-        action="store_true", default=False
+        action="store_true",
+        default=False,
     )
     connections.add_argument(
         "-p",
         "--purchasable",
         help="whether or not the result should only trains purchasable on koleo",
-        action="store_true", default=False
+        action="store_true",
+        default=False,
     )
     connections.set_defaults(func=cli.connections, pass_=["start", "end", "brands", "date", "direct", "purchasable"])
 

{koleo_cli-0.2.137.4 → koleo_cli-0.2.137.6}/koleo/storage.py

@@ -27,9 +27,9 @@ T = t.TypeVar("T")
 @dataclass
 class Storage:
     favourite_station: str | None = None
-    last_searched_connections: list[tuple[str, str]] = field(default_factory=list)
-    last_searched_stations: list[str] = field(default_factory=list)
     cache: dict[str, tuple[int, t.Any]] = field(default_factory=dict)
+    disable_cache: bool = False
+    use_roman_numerals: bool = False
 
     def __post_init__(self):
         self._path: str
@@ -47,6 +47,8 @@ class Storage:
         return storage
 
     def get_cache(self, id: str) -> t.Any | None:
+        if self.disable_cache:
+            return
         cache_result = self.cache.get(id)
         if not cache_result:
             return
@@ -58,6 +60,8 @@ class Storage:
             self.save()
 
     def set_cache(self, id: str, item: T, ttl: int = 86400) -> T:
+        if self.disable_cache:
+            return item
         self.cache[id] = (int(time() + ttl), item)
         self.save()
         return item

{koleo_cli-0.2.137.4 → koleo_cli-0.2.137.6}/koleo/types.py

@@ -179,8 +179,8 @@ class TrainDetailResponse(t.TypedDict):
 
 
 class ConnectionTrainStop(t.TypedDict):
-    arrival: TimeDict | str # WTF KOLEO!!!!
-    departure: TimeDict | str # WTF KOLEO!!!!
+    arrival: TimeDict | str  # WTF KOLEO!!!!
+    departure: TimeDict | str  # WTF KOLEO!!!!
     distance: int
     in_path: bool
     station_id: int
@@ -196,8 +196,8 @@ class ConnectionTrainStop(t.TypedDict):
 
 
 class ConnectiontrainDetail(TrainDetail):
-    arrival: TimeDict | str # WTF KOLEO!!!!
-    departure: TimeDict | str # WTF KOLEO!!!!
+    arrival: TimeDict | str  # WTF KOLEO!!!!
+    departure: TimeDict | str  # WTF KOLEO!!!!
     stops: list[ConnectionTrainStop]
     bookable: bool
     train_attribute_ids: list[int]
@@ -225,8 +225,8 @@ class ConnectionDetail(t.TypedDict):
     brand_ids: list[int]
     start_station_id: int
     end_station_id: int
-    arrival: TimeDict | str # WTF KOLEO!!!!
-    departure: TimeDict | str # WTF KOLEO!!!!
+    arrival: TimeDict | str  # WTF KOLEO!!!!
+    departure: TimeDict | str  # WTF KOLEO!!!!
     bookable: bool
     special_event_slug: str | None
     is_advanced_travel_options: bool
@@ -234,4 +234,4 @@ class ConnectionDetail(t.TypedDict):
     max_passengers_count: bool
     constriction_info: list[str]
     is_estimated_timetable_available: bool
-    trains: list[ConnectiontrainDetail]
+    trains: list[ConnectiontrainDetail]

{koleo_cli-0.2.137.4 → koleo_cli-0.2.137.6}/koleo/utils.py

@@ -1,3 +1,4 @@
+from argparse import Action
 from datetime import datetime, time, timedelta
 
 from .types import TimeDict
@@ -64,9 +65,14 @@ NUMERAL_TO_ARABIC = {
     "X": 10,
     "XI": 11,  # wtf poznań???
     "XII": 12,  # just to be safe
-    "BUS": "BUS"
+    "BUS": "BUS",
 }
 
 
 def convert_platform_number(number: str) -> int | None | str:
     return NUMERAL_TO_ARABIC.get(number)
+
+
+class RemainderString(Action):
+    def __call__(self, _, namespace, values: list[str], __):
+        setattr(namespace, self.dest, " ".join(values) if values else self.default)

koleo_cli-0.2.137.6/koleo_cli.egg-info/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.1
+Name: koleo-cli
+Version: 0.2.137.6
+Summary: Koleo CLI
+Home-page: https://github.com/lzgirlcat/koleo-cli
+Author: Zoey !
+Maintainer-email: cb98uzhd@duck.com
+License: GNU General Public License v3.0
+Project-URL: Source (GitHub), https://github.com/lzgirlcat/koleo-cli
+Project-URL: Issue Tracker, https://github.com/lzgirlcat/koleo-cli/issues
+Keywords: koleo,timetable,trains,rail,poland
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: rich==13.7.1
+Requires-Dist: requests==2.31.0
+
+[![PyPI - Version](https://img.shields.io/pypi/v/koleo-cli.svg)](https://pypi.org/project/koleo-cli)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/koleo-cli.svg)](https://pypi.org/project/koleo-cli)
+
+# Koleo CLI
+
+![gif showcasing the functionality](https://github.com/lzgirlcat/koleo-cli/blob/main/koleo-cli.gif?raw=true)
+
+
+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
+```

{koleo_cli-0.2.137.4 → koleo_cli-0.2.137.6}/setup.py

@@ -14,7 +14,7 @@ def parse_requirements_file(path):
 
 setuptools.setup(
     name="koleo-cli",
-    version="0.2.137.4",
+    version="0.2.137.6",
     description="Koleo CLI",
     long_description=long_description(),
     long_description_content_type="text/markdown",

koleo_cli-0.2.137.4/PKG-INFO

@@ -1,17 +0,0 @@
-Metadata-Version: 2.1
-Name: koleo-cli
-Version: 0.2.137.4
-Summary: Koleo CLI
-Home-page: https://github.com/lzgirlcat/koleo-cli
-Author: Zoey !
-Maintainer-email: cb98uzhd@duck.com
-License: GNU General Public License v3.0
-Project-URL: Source (GitHub), https://github.com/lzgirlcat/koleo-cli
-Project-URL: Issue Tracker, https://github.com/lzgirlcat/koleo-cli/issues
-Keywords: koleo,timetable,trains,rail,poland
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-Requires-Dist: rich==13.7.1
-Requires-Dist: requests==2.31.0

koleo_cli-0.2.137.4/koleo_cli.egg-info/PKG-INFO

@@ -1,17 +0,0 @@
-Metadata-Version: 2.1
-Name: koleo-cli
-Version: 0.2.137.4
-Summary: Koleo CLI
-Home-page: https://github.com/lzgirlcat/koleo-cli
-Author: Zoey !
-Maintainer-email: cb98uzhd@duck.com
-License: GNU General Public License v3.0
-Project-URL: Source (GitHub), https://github.com/lzgirlcat/koleo-cli
-Project-URL: Issue Tracker, https://github.com/lzgirlcat/koleo-cli/issues
-Keywords: koleo,timetable,trains,rail,poland
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-Requires-Dist: rich==13.7.1
-Requires-Dist: requests==2.31.0