pytekukko -- Jätekukko Omakukko API client

Simple Python asyncio client for the Jätekukko Omakukko API.

The API of this package is modeled closely after the Omakukko API. Only read operations are implemented (well apart from, strictly speaking, login/logout), and there are no plans to add support for any write ones.

Usage in a nutshell:

• construct an aiohttp ClientSession,
• construct a Pytekukko client with it and your credentials,
• invoke methods on the client.

The Omakukko API uses token based sessions. The token is stored in the client's token attribute, persist and load it as appropriate to maintain the session across interpreter restarts. The service also sets some cookies, use a persistent CookieJar to maintain them similarly.

High level client methods handle logging in when the need to do so is 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 --help for usage and setup information:

• pytekukko-invoices: output basic info on invoices in JSON
• pytekukko-next-emptyings: output next emptying dates in JSON
• pytekukko-planned-emptyings: output planned emptying schedules in JSON or iCalendar

Shell completions for the examples can be generated with shtab's CLI usage mode.

shtab \
  --prog pytekukko-invoices \
  --prefix pytekukko_invoices \
  pytekukko.examples.print_invoices.argparser
shtab \
  --prog pytekukko-next-emptyings \
  --prefix pytekukko_next_emptyings \
  pytekukko.examples.print_next_emptyings.argparser
shtab \
  --prog pytekukko-planned-emptyings \
  --prefix pytekukko_planned_emptyings \
  pytekukko.examples.print_planned_emptyings.argparser

Disclaimer

This package is not supported by or endorsed by Jätekukko. Do not bother them with questions or issues related to it.