pytekukko 0.16.0__py3-none-any.whl → 0.17.0__py3-none-any.whl

pytekukko/__init__.py

@@ -13,7 +13,7 @@ from aiohttp import ClientResponse, ClientResponseError, ClientSession
 from .exceptions import UnexpectedResponseStructureError
 from .models import CustomerData, InvoiceHeader, Service
 
-__version__ = "0.16.0"
+__version__ = "0.17.0"
 DEFAULT_BASE_URL = "https://tilasto.jatekukko.fi/jatekukko/"
 
 SERVICE_TIMEZONE = ZoneInfo("Europe/Helsinki")
@@ -77,7 +77,7 @@ class Pytekukko:
             params=params,
         )
 
-        return cast(list[date], _unmarshal(response_data))
+        return cast("list[date]", _unmarshal(response_data))
 
     async def get_invoice_headers(self) -> list[InvoiceHeader]:
         """Get headers of available invoices."""
@@ -114,7 +114,7 @@ class Pytekukko:
             raise_for_status=True,
         ) as response:
             # NOTE(scop): could check that we got {"response":"OK"}
-            return cast(dict[str, str], await response.json())
+            return cast("dict[str, str]", await response.json())
 
     async def logout(self) -> None:
         """Log out the current session."""

pytekukko/examples/print_collection_schedules.py

@@ -2,6 +2,7 @@
 
 """Print collection schedules."""
 
+import argparse
 import asyncio
 import json
 import sys
@@ -13,13 +14,21 @@ import pytekukko
 from pytekukko.examples import example_argparser, example_client
 
 
-async def run_example() -> None:
-    """Run the example."""
+def argparser() -> argparse.ArgumentParser:
+    """Return an argument parser for the example.
+
+    This is a separate function to facilitate shtab generated completions.
+    """
     argparser = example_argparser(__doc__)
     argparser.add_argument(
         "-i", "--icalendar", action="store_true", help="output iCalendar"
     )
-    args = argparser.parse_args()
+    return argparser
+
+
+async def run_example() -> None:
+    """Run the example."""
+    args = argparser().parse_args()
 
     client, cookie_jar, cookie_jar_path = example_client(args)
 

pytekukko/examples/print_invoice_headers.py

@@ -2,17 +2,24 @@
 
 """Print basic info on invoices."""
 
+import argparse
 import asyncio
 import json
 
 from pytekukko.examples import example_argparser, example_client
 
 
+def argparser() -> argparse.ArgumentParser:
+    """Return an argument parser for the example.
+
+    This is a separate function to facilitate shtab generated completions.
+    """
+    return example_argparser(__doc__)
+
+
 async def run_example() -> None:
     """Run the example."""
-    client, cookie_jar, cookie_jar_path = example_client(
-        example_argparser(__doc__).parse_args(),
-    )
+    client, cookie_jar, cookie_jar_path = example_client(argparser().parse_args())
 
     async with client.session:
         data = [

pytekukko/examples/print_next_collections.py

@@ -2,17 +2,24 @@
 
 """Print next collection dates."""
 
+import argparse
 import asyncio
 import json
 
 from pytekukko.examples import example_argparser, example_client
 
 
+def argparser() -> argparse.ArgumentParser:
+    """Return an argument parser for the example.
+
+    This is a separate function to facilitate shtab generated completions.
+    """
+    return example_argparser(__doc__)
+
+
 async def run_example() -> None:
     """Run the example."""
-    client, cookie_jar, cookie_jar_path = example_client(
-        example_argparser(__doc__).parse_args(),
-    )
+    client, cookie_jar, cookie_jar_path = example_client(argparser().parse_args())
 
     async with client.session:
         data = [

pytekukko/models.py

@@ -21,12 +21,12 @@ class Service:
     @property
     def name(self) -> str:
         """Get service name."""
-        return cast(str, self.raw_data["ASTNimi"])
+        return cast("str", self.raw_data["ASTNimi"])
 
     @property
     def pos(self) -> int:
         """Get "pos" value."""
-        return cast(int, self.raw_data["ASTPos"])
+        return cast("int", self.raw_data["ASTPos"])
 
     @property
     def next_collection(self) -> date | None:
@@ -50,12 +50,12 @@ class CustomerData:
     @property
     def customer_number(self) -> str:
         """Get customer number."""
-        return cast(str, self.raw_data["asiakasnro"])
+        return cast("str", self.raw_data["asiakasnro"])
 
     @property
     def name(self) -> str:
         """Get customer name."""
-        return cast(str, self.raw_data["nimi"])
+        return cast("str", self.raw_data["nimi"])
 
 
 @dataclass
@@ -71,14 +71,14 @@ class InvoiceHeader:
     @property
     def name(self) -> str:
         """Get customer number."""
-        return cast(str, self.raw_data["name"])
+        return cast("str", self.raw_data["name"])
 
     @property
     def due_date(self) -> date:
         """Get due date."""
-        return cast(date, self.raw_data["dueDate"])
+        return cast("date", self.raw_data["dueDate"])
 
     @property
     def total(self) -> float:
         """Get total amount."""
-        return cast(float, self.raw_data["total"])
+        return cast("float", self.raw_data["total"])

{pytekukko-0.16.0.dist-info → pytekukko-0.17.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: pytekukko
-Version: 0.16.0
+Version: 0.17.0
 Summary: Jätekukko Omakukko API client
 Author-email: Ville Skyttä <ville.skytta@iki.fi>
 License: 
@@ -219,19 +219,20 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: aiohttp ~=3.4
+Requires-Dist: aiohttp~=3.4
 Provides-Extra: examples
-Requires-Dist: python-dotenv <2,>=0.10 ; extra == 'examples'
-Requires-Dist: google-api-python-client >=2.0.2,~=2.0 ; extra == 'examples'
-Requires-Dist: icalendar ~=5.0 ; extra == 'examples'
+Requires-Dist: python-dotenv<2,>=0.10; extra == "examples"
+Requires-Dist: icalendar<7,>=5; extra == "examples"
+Dynamic: license-file
 
 # pytekukko -- Jätekukko Omakukko API client
 
 [![Python versions](https://img.shields.io/pypi/pyversions/pytekukko.svg)](https://pypi.org/project/pytekukko/)
 [![PyPI version](https://badge.fury.io/py/pytekukko.svg)](https://badge.fury.io/py/pytekukko)
-[![CI status](https://github.com/scop/pytekukko/workflows/check/badge.svg)](https://github.com/scop/pytekukko/actions?query=workflow%3Acheck)
+[![CI status](https://github.com/scop/pytekukko/actions/workflows/test.yaml/badge.svg)](https://github.com/scop/pytekukko/actions/workflows/test.yaml)
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/scop/pytekukko/badge)](https://scorecard.dev/viewer/?uri=github.com%2Fscop%2Fpytekukko)
 
-Simple asyncio client for the [Jätekukko](https://www.jatekukko.fi)
+Simple Python asyncio client for the [Jätekukko](https://www.jatekukko.fi)
 [Omakukko](https://tilasto.jatekukko.fi/indexservice2.jsp) API.
 
 The API of this package is modeled closely after the Omakukko
@@ -254,6 +255,8 @@ detected. If the detection is successful, there is no need to
 separately track session expiration or use the `login` method in the
 first place.
 
+## Command line examples
+
 For usage examples, see utilities in the `pytekukko.examples`
 package. Executables and dependencies for these are installed when the
 package is installed with the `examples` extra, invoke them with
@@ -262,8 +265,28 @@ package is installed with the `examples` extra, invoke them with
 - `pytekukko-collection-schedules`: output collection schedules in JSON
 - `pytekukko-invoice-headers`: output basic info on invoices in JSON
 - `pytekukko-next-collections`: output next collection dates in JSON
-- `pytekukko-update-google-calendar`: update Google Calendar with
-  events for next collections
+
+Shell completions for the examples can be generated with
+[shtab's CLI usage mode](https://docs.iterative.ai/shtab/use/#cli-usage).
+
+<details>
+
+```shell
+shtab \
+  --prog pytekukko-collection-schedules \
+  --prefix pytekukko_collection_schedules \
+  pytekukko.examples.print_collection_schedules.argparser
+shtab \
+  --prog pytekukko-invoice-headers \
+  --prefix pytekukko_invoice_headers \
+  pytekukko.examples.print_invoice_headers.argparser
+shtab \
+  --prog pytekukko-next-collections \
+  --prefix pytekukko_next_collections \
+  pytekukko.examples.print_next_collections.argparser
+```
+
+</details>
 
 ## Disclaimer
 

pytekukko-0.17.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+pytekukko/__init__.py,sha256=Kp4WRJ0Vfqdicd8E-e0jdu-ndyKA7SgQkUuQan7d6N8,6561
+pytekukko/exceptions.py,sha256=qGxEaKkr6t0ApvOb-_12PjEUwmEZDCMQ4s5BAgde8Og,353
+pytekukko/models.py,sha256=W--ERpT3ueoC_cyULHcyB_H41fy5IHhard9JF1rEl_g,2329
+pytekukko/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pytekukko/examples/__init__.py,sha256=okWI6GachxrBvvHR-WElMnzki7Fyq-SB5I35gYUziow,2746
+pytekukko/examples/print_collection_schedules.py,sha256=oGT2Pcju31UDicPnkBm1am56MXUZ-Zh6EzM53B5te-w,2665
+pytekukko/examples/print_invoice_headers.py,sha256=2dbPJBg0leeFE8_b5EK4KcCPOAjBKKguK_8caBnH_OI,1151
+pytekukko/examples/print_next_collections.py,sha256=U_2SWnuEqBWrcO8mymrVM71Av67Oqu96P8vCSsKng_A,1128
+pytekukko-0.17.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+pytekukko-0.17.0.dist-info/METADATA,sha256=Qvp3gNp896-1o1BVE5Bm813WpNhOI2m7bSjcomg_MmM,16688
+pytekukko-0.17.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pytekukko-0.17.0.dist-info/entry_points.txt,sha256=_nWk7vXD6paxSMR4HJZArDj0GEdazivnwI1YUJup2GE,285
+pytekukko-0.17.0.dist-info/top_level.txt,sha256=CozVPCHdY-e4oxKq01MVWfy3ge_5BlV0I465LUsfchk,10
+pytekukko-0.17.0.dist-info/RECORD,,

{pytekukko-0.16.0.dist-info → pytekukko-0.17.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{pytekukko-0.16.0.dist-info → pytekukko-0.17.0.dist-info}/entry_points.txt

@@ -2,4 +2,3 @@
 pytekukko-collection-schedules = pytekukko.examples.print_collection_schedules:main [examples]
 pytekukko-invoice-headers = pytekukko.examples.print_invoice_headers:main [examples]
 pytekukko-next-collections = pytekukko.examples.print_next_collections:main [examples]
-pytekukko-update-google-calendar = pytekukko.examples.update_google_calendar:main [examples]

pytekukko/examples/update_google_calendar.py

@@ -1,211 +0,0 @@
-#!/usr/bin/env python3
-
-"""Update Google Calendar with events for next collections.
-
-To get the required service account file, enable the Google Calendar API
-in the Google Cloud console, create service account credentials with
-access to it, and create keys of type JSON.
-
-Calendar id is typically the target Google Calendar account e-mail
-address.
-"""
-
-import asyncio
-import datetime
-import logging
-import sys
-import zoneinfo
-from collections.abc import Mapping
-from typing import Any, NamedTuple, cast
-
-from google.oauth2 import service_account  # type: ignore[import-untyped]
-from googleapiclient.discovery import build  # type: ignore[import-untyped]
-
-from pytekukko.examples import arg_environ_default, example_argparser, example_client
-
-logging.basicConfig(level=logging.INFO)
-LOGGER = logging.getLogger(__name__)
-
-
-class CalendarData(NamedTuple):
-    """Helper container for calendar data to update."""
-
-    name: str
-    date: datetime.date
-    location: str
-
-
-# https://developers.google.com/resources/api-libraries/documentation/calendar/v3/python/latest/calendar_v3.events.html
-def update_google_calendar(
-    credentials: service_account.Credentials,
-    calendar_id: str,
-    data: Mapping[str, CalendarData],
-) -> None:
-    """Update the calendar."""
-    service = build(
-        "calendar",
-        "v3",
-        credentials=credentials,
-        # https://github.com/googleapis/google-api-python-client/issues/299
-        # https://github.com/googleapis/google-api-python-client/issues/325
-        cache_discovery=False,
-    )
-
-    # Events with only date set are apparently treated as occurring at midnight,
-    # start of day in calendar's timezone.
-    calendar = service.calendars().get(calendarId=calendar_id).execute()
-    if calendar.get("timeZone"):
-        timezone: datetime.tzinfo = zoneinfo.ZoneInfo(calendar["timeZone"])
-    else:
-        timezone = datetime.timezone.utc
-    since = datetime.datetime.now(timezone).replace(hour=0) - datetime.timedelta(
-        hours=1,
-    )
-
-    events = (
-        service.events()
-        .list(
-            calendarId=calendar_id,
-            orderBy="startTime",
-            singleEvents=True,
-            timeMin=since.isoformat(),
-            privateExtendedProperty="pytekukko-managed=true",
-        )
-        .execute()
-    )
-
-    pos_events: dict[str, dict[str, Any]] = {}
-    for event in events["items"]:
-        # Store first event for each pos for update, delete rest
-        pos = event["extendedProperties"]["private"].get("pytekukko-pos")
-        if pos and pos in data and not pos_events.get(pos):
-            pos_events[pos] = event
-        else:
-            service.events().delete(
-                calendarId=calendar_id,
-                eventId=event["id"],
-            ).execute()
-
-    for pos, pos_event_data in data.items():
-        date = pos_event_data.date.isoformat()
-        name = pos_event_data.name or ""
-        description = f"{name} [pos={pos}]".strip()
-        event_data = {
-            "summary": "Jätekukko collection",
-            "description": description,
-            "location": pos_event_data.location or None,
-            "start": {"date": date},
-            "end": {"date": date},
-            # Reminders are "for the authenticated user" per docs.
-            # So for the service account, not the calendar owner :(
-            # No way to set this for the "actual" calendar user from here,
-            # at least while using a service account.
-            "reminders": {"useDefault": False},
-            "transparency": "transparent",
-            "extendedProperties": {
-                "private": {"pytekukko-managed": "true", "pytekukko-pos": pos},
-            },
-            "source": {
-                "url": "https://tilasto.jatekukko.fi/indexservice2.jsp",
-                "title": "Omakukko",
-            },
-            "creator": {
-                "displayName": "Pytekukko",
-            },
-        }
-
-        event = pos_events.get(pos)
-
-        method = None
-        log_level = logging.INFO
-        if event:
-            for key, value in event_data.items():
-                if event.get(key) != value:
-                    action = "updated"
-                    method = service.events().patch(
-                        calendarId=calendar_id,
-                        eventId=event["id"],
-                        body=event_data,
-                    )
-                    break
-            else:
-                action = "unchanged"
-                log_level = logging.DEBUG
-        else:
-            action = "created"
-            method = service.events().insert(
-                calendarId=calendar_id,
-                body=event_data,
-            )
-        if method:
-            event = method.execute()
-        LOGGER.log(log_level, "Event %s: %s", action, event.get("htmlLink"))
-
-
-async def run_example() -> None:
-    """Run the example."""
-    argparser = example_argparser(__doc__)
-    argparser.add_argument(
-        "--google-calendar-id",
-        type=str,
-        **arg_environ_default("PYTEKUKKO_GOOGLE_CALENDAR_ID"),  # type: ignore[arg-type]
-    )
-    argparser.add_argument(
-        "--google-service-account-file",
-        type=str,
-        **arg_environ_default(  # type: ignore[arg-type]
-            "PYTEKUKKO_GOOGLE_SERVICE_ACCOUNT_FILE",
-            fallback="service_account.json",
-        ),
-    )
-    args = argparser.parse_args()
-
-    if not args.google_calendar_id:
-        print("Google calendar id required", file=sys.stderr)  # noqa: T201
-        sys.exit(2)
-
-    client, cookie_jar, cookie_jar_path = example_client(args)
-
-    credentials = service_account.Credentials.from_service_account_file(
-        args.google_service_account_file,
-    )
-
-    async with client.session:
-        services = await client.get_services()
-        if not cookie_jar_path:
-            await client.logout()
-
-    if cookie_jar_path:
-        cookie_jar.save(cookie_jar_path)
-
-    data = {}
-    for service in (x for x in services if x.next_collection):
-        data[str(service.pos)] = CalendarData(
-            name=service.name,
-            date=cast(datetime.date, service.next_collection),
-            location=", ".join(
-                x
-                for x in (
-                    service.raw_data.get("owner", {}).get("katu"),
-                    service.raw_data.get("owner", {}).get("posti"),
-                )
-                if x
-            ),
-        )
-
-    await asyncio.get_event_loop().run_in_executor(
-        None,
-        update_google_calendar,
-        credentials,
-        args.google_calendar_id,
-        data,
-    )
-
-
-def main() -> None:
-    """Run example in event loop."""
-    asyncio.run(run_example())
-
-
-if __name__ == "__main__":
-    main()

pytekukko-0.16.0.dist-info/RECORD

@@ -1,15 +0,0 @@
-pytekukko/__init__.py,sha256=lh5p0fm7hE6bK-q_ikFuV-4nLOJIhzD7POfOGmYJQGs,6557
-pytekukko/exceptions.py,sha256=qGxEaKkr6t0ApvOb-_12PjEUwmEZDCMQ4s5BAgde8Og,353
-pytekukko/models.py,sha256=DePgMRUKXkmJVDiXSREVB7JB3Fe7K-tp9Z9VIv0hcIE,2315
-pytekukko/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pytekukko/examples/__init__.py,sha256=okWI6GachxrBvvHR-WElMnzki7Fyq-SB5I35gYUziow,2746
-pytekukko/examples/print_collection_schedules.py,sha256=Qe5X-3iTGpclh_kHdSIaJEpjXVTXw9BTWPEYajj1Ljc,2446
-pytekukko/examples/print_invoice_headers.py,sha256=-yjNMdFyGI6X5eAUFtoy4qO9A4HzaJ7Uz7YO_C_7m6o,947
-pytekukko/examples/print_next_collections.py,sha256=TyxsmQ60zCMOmalIo17YAV9_7yjWSbCYgdZG-ZfOKpU,924
-pytekukko/examples/update_google_calendar.py,sha256=cbFEtRQtsE2EitvkOD5rQZeJAlspqkPD-2AJyS07kog,6706
-pytekukko-0.16.0.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-pytekukko-0.16.0.dist-info/METADATA,sha256=ogtbPoHI5YiSq8SSLYurqdM9Ltofr_dPh-HVQRGUONc,16046
-pytekukko-0.16.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-pytekukko-0.16.0.dist-info/entry_points.txt,sha256=p4qVa_J7SI2g3UoYq9Em_vPBz9DXXzIqL3wpcud2J0o,378
-pytekukko-0.16.0.dist-info/top_level.txt,sha256=CozVPCHdY-e4oxKq01MVWfy3ge_5BlV0I465LUsfchk,10
-pytekukko-0.16.0.dist-info/RECORD,,