models ¤

An account.

Attributes:

• direct_sponsor (bool) –

  Return whether the account is a direct sponsor.

• excluded (bool) –

  Indicates if the account is excluded from the sponsors list.

• highest_tier (int) –

  Return the highest tier amount.

• image (str | None) –

  The image URL of the account.

• included (bool) –

  Indicates if the account is included in the sponsors list.

• is_org (bool) –

  Indicates if the account is an organization.

• is_user (bool) –

  Return whether the account is a user.

• name (str) –

  The name of the account.

• platform (SponsorshipPlatform) –

  The platform of the account.

• sponsorships (list[Sponsorship]) –

  List of sponsorships associated with the account

• tier_sum (int) –

  Return the sum of all tier amounts.

• url (str | None) –

  The URL of the account.

direct_sponsor: bool

excluded: bool = False

highest_tier: int

image: str | None = None

included: bool = False

is_org: bool = False

is_user: bool

name: str

platform: SponsorshipPlatform

sponsorships: list[Sponsorship] = field(
    default_factory=list
)

tier_sum: int

url: str | None = None

Backlog of issues.

Classes:

• SortStrategy –

Methods:

• sort –

  Sort the backlog.

Attributes:

• issues (list[Issue]) –

  A list of issues.

issues: list[Issue] = field(default_factory=list)

author_sponsorships(
    *, reverse: bool = True
) -> Callable[[Issue], int]

created(*, reverse: bool = False) -> Callable[[Issue], int]

label(
    name: str, *, reverse: bool = True
) -> Callable[[Issue], int]

min_author_sponsorships(
    amount: int, *, reverse: bool = True
) -> Callable[[Issue], int]

min_pledge(
    amount: int, *, reverse: bool = True
) -> Callable[[Issue], int]

min_sponsorships(
    amount: int, *, reverse: bool = True
) -> Callable[[Issue], int]

min_upvoters_sponsorships(
    amount: int, *, reverse: bool = True
) -> Callable[[Issue], int]

min_upvotes(
    amount: int, *, reverse: bool = True
) -> Callable[[Issue], int]

pledge(*, reverse: bool = True) -> Callable[[Issue], int]

repository(
    name: str, *, reverse: bool = True
) -> Callable[[Issue], int]

sponsorships(
    *, reverse: bool = True
) -> Callable[[Issue], int]

upvoters_sponsorships(
    *, reverse: bool = True
) -> Callable[[Issue], int]

upvotes(*, reverse: bool = True) -> Callable[[Issue], int]

sort(*strats: Callable[[Issue], Any]) -> None

A sponsorship beneficiary: a user, grant bit, and optional org.

Attributes:

• grant (bool | None) –

  Whether the user is granted access to Insiders (in addition to getting voting power).

• org (Account | None) –

  The organization the user benefits from.

• user (Account) –

  The user who benefits from the sponsorship.

grant: bool | None = None

org: Account | None = None

user: Account

An issue.

Attributes:

• author (Account) –

  The issue author.

• created (datetime) –

  The issue creation date.

• labels (set[str]) –

  The issue labels.

• number (int) –

  The issue number.

• platform (IssuePlatform) –

  The issue platform.

• pledged (int) –

  The amount pledged.

• repository (str) –

  The issue repository.

• title (str) –

  The issue title.

• upvotes (set[Account]) –

  The issue upvotes / upvoters.

author: Account

created: datetime

labels: set[str] = field(default_factory=set)

number: int

platform: IssuePlatform

pledged: int = 0

repository: str

title: str

upvotes: set[Account] = field(default_factory=set)

Wrapper class for sponsorships.

Methods:

• merge –

Attributes:

• accounts (set[Account]) –

  Set of accounts who created sponsorships.

• beneficiaries (dict[str, Beneficiary]) –

  Beneficiaries of all sponsorships.

• sponsorships (list[Sponsorship]) –

  Sponsorships.

accounts: set[Account]

beneficiaries: dict[str, Beneficiary]

sponsorships: list[Sponsorship] = field(
    default_factory=list
)

merge(other: Sponsors) -> Sponsors

A sponsorship.

Attributes:

• account (Account) –

  The account who created the sponsorship

• amount (int) –

  The amount of the sponsorship

• beneficiaries (dict[str, Beneficiary]) –

  Beneficiaries of this sponsorship.

• created (datetime) –

  The creation date of the sponsorship

• private (bool) –

  Indicates if the sponsorship is private

account: Account

amount: int

beneficiaries: dict[str, Beneficiary] = field(
    default_factory=dict
)

created: datetime

private: bool = True