Skip to content

Python SDK API Reference

Classes:

  • SZGFClient –

    Client for interacting with the SZGF guides repository.

SZGFClient

Client for interacting with the SZGF guides repository.

Methods:

  • download_guides –

    Download all guides from the GitHub repository and store them locally.

  • read_guides –

    Read all locally stored guides and parse them into ParsedGuide objects.

  • start –

    Start the client session.

  • close –

    Close the client session.

Attributes:

session property 

session: ClientSession

download_guides async 

download_guides() -> None

Download all guides from the GitHub repository and store them locally.

read_guides async 

read_guides() -> dict[str, ParsedGuide]

Read all locally stored guides and parse them into ParsedGuide objects.

Returns:

  • dict[str, ParsedGuide] –

    A dictionary mapping character IDs to ParsedGuide objects.

start async 

start() -> None

Start the client session.

close async 

close() -> None

Close the client session.