Skip to content

polar ¤

Classes:

  • Polar

    Polar client.

Polar ¤

Polar(token: str)

Bases: Client

Polar client.

Initialize Polar API client.

Parameters:

  • token (str) –

    A Polar API token. Recommended scopes: user:read, issues:read, subscriptions:read.

Methods:

get_issues ¤

get_issues(
    github_accounts: Iterable[str],
    known_github_users: Iterable[Account] | None = None,
) -> IssueDict

Get issues from Polar.

Parameters:

  • github_accounts (Iterable[str]) –

    GitHub accounts to fetch issues from.

  • known_github_users (Iterable[Account] | None, default: None ) –

    Known GitHub user accounts.

Returns:

  • IssueDict

    Issues data.

get_sponsors ¤

get_sponsors(*, exclude_private: bool = False) -> Sponsors

Get Polar sponsorships.

Parameters:

  • exclude_private (bool, default: False ) –

Returns: