insiders ¤

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]

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

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

min_author_sponsorships(
    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]

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).

• user (Account) –

  The user who benefits from the sponsorship.

grant: bool | None = None

user: Account

Command to list the backlog of issues.

Methods:

• __call__ –

  Run the command.

Attributes:

• backlog_namespaces (list[str]) –

  Namespaces to fetch issues from.

• github_beneficiaries (dict[str, list[str]]) –

  Beneficiaries of GitHub sponsors.

• github_token (str) –

  A GitHub token. Recommended scopes: read:user.

• issue_labels (dict[str, str]) –

  Issue labels to keep in issues metadata, and how they are represented.

• limit (int) –

  Limit the number of issues to display.

• polar_beneficiaries (dict[str, list[str]]) –

  Beneficiaries of Polar sponsors.

• polar_token (str) –

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

• public (bool) –

  Only use public sponsorships.

• sort (list[Callable]) –

  Sort strategy.

backlog_namespaces: list[str]

github_beneficiaries: dict[str, list[str]] = field(
    default_factory=dict
)

github_token: str = ''

issue_labels: dict[str, str] = field(default_factory=dict)

limit: int = 0

polar_beneficiaries: dict[str, list[str]] = field(
    default_factory=dict
)

polar_token: str = ''

public: bool = False

sort: list[Callable] = field(default_factory=list)

__call__() -> int

Command to manage the local index.

Attributes:

• subcommand (CommandIndexList | CommandIndexAdd | CommandIndexRemove | CommandIndexUpdate | CommandIndexStart | CommandIndexStatus | CommandIndexStop | CommandIndexLogs) –

  The selected subcommand.

subcommand: (
    CommandIndexList
    | CommandIndexAdd
    | CommandIndexRemove
    | CommandIndexUpdate
    | CommandIndexStart
    | CommandIndexStatus
    | CommandIndexStop
    | CommandIndexLogs
)

Command to add a repository to the watched repositories.

Methods:

• __call__ –

  Run the command.

Attributes:

• distributions_directory (Path) –

  Directory where the distributions are stored.

• repositories (list[str]) –

  List of repositories (GitHub namespace/project or Git URL git@host:repo).

• sources_directory (Path) –

  Directory where the sources are stored.

• url (str) –

  URL of the index to upload packages to.

distributions_directory: Path = DEFAULT_DIST_DIR

repositories: list[str]

sources_directory: Path = DEFAULT_REPO_DIR

url: str = DEFAULT_INDEX_URL

__call__() -> int

Command to list the watched repositories.

Methods:

• __call__ –

  Run the command.

Attributes:

• distributions_directory (Path) –

  Directory where the distributions are stored.

• dists (bool) –

  List distributions.

• projects (bool) –

  List projects.

• sources_directory (Path) –

  Directory where the sources are stored.

distributions_directory: Path = DEFAULT_DIST_DIR

dists: bool = False

projects: bool = False

sources_directory: Path = DEFAULT_REPO_DIR

__call__() -> int

Command to show the server logs.

Methods:

• __call__ –

  Run the command.

__call__() -> int

Command to remove a repository and its distributions (if served locally).

Methods:

• __call__ –

  Run the command.

Attributes:

• distributions_directory (Path) –

  Directory where the distributions are stored.

• repositories (list[str]) –

  List of repository names.

• sources_directory (Path) –

  Directory where the sources are stored.

distributions_directory: Path = DEFAULT_DIST_DIR

repositories: list[str]

sources_directory: Path = DEFAULT_REPO_DIR

__call__() -> int

Command to start the server.

Methods:

• __call__ –

  Run the command.

Attributes:

• background (bool) –

  Run the server in the background.

• distributions_directory (Path) –

  Directory where the distributions are stored.

• log_path (str | None) –

  Where to write index server logs.

• sources_directory (Path) –

  Directory where the sources are stored.

• url (str) –

  URL to serve the index at.

background: bool = False

distributions_directory: Path = DEFAULT_DIST_DIR

log_path: str | None = None

sources_directory: Path = DEFAULT_REPO_DIR

url: str = DEFAULT_INDEX_URL

__call__() -> int

Command to show the server status.

Methods:

• __call__ –

  Run the command.

__call__() -> int

Command to stop the server.

Methods:

• __call__ –

  Run the command.

__call__() -> int

Command to update watched projects.

Methods:

• __call__ –

  Run the command.

Attributes:

• distributions_directory (Path) –

  Directory where the distributions are stored.

• repositories (list[str]) –

  List of repository names.

• sources_directory (Path) –

  Directory where the sources are stored.

• url (str) –

  URL of the index to upload packages to.

distributions_directory: Path = DEFAULT_DIST_DIR

repositories: list[str] = field(default_factory=list)

sources_directory: Path = DEFAULT_REPO_DIR

url: str = DEFAULT_INDEX_URL

__call__() -> int

Command to manage your Insiders projects.

Attributes:

• config (Config) –

  Path to the configuration file.

• debug_info (bool) –

  Print debug information.

• log_downgrade (tuple[str, ...]) –

  Downgrade INFO logs to DEBUG for logs originating from these modules/loggers. By default, all dependency logs are downgraded.

• log_exclude (tuple[str, ...]) –

  Exclude logs originating from these modules/loggers. Applied after inclusion. By default, nothing is excluded.

• log_include (tuple[str, ...]) –

  Include logs originating from these modules/loggers. By default, all logs are included.

• log_level (Literal['TRACE', 'DEBUG', 'INFO', 'SUCCESS', 'WARNING', 'ERROR', 'CRITICAL']) –

  Lowest log level to display. Levels below that will be hidden.

• log_path (str | None) –

  Write log messages to this file path.

• subcommand (CommandBacklog | CommandIndex | CommandProject | CommandSponsors) –

  The selected subcommand.

• version (bool) –

  Print the program version and exit.

config: Config = field(default_factory=_load_config)

debug_info: bool = False

log_downgrade: tuple[str, ...] = field(
    default_factory=tuple
)

log_exclude: tuple[str, ...] = field(default_factory=tuple)

log_include: tuple[str, ...] = field(default_factory=tuple)

log_level: Literal[
    "TRACE",
    "DEBUG",
    "INFO",
    "SUCCESS",
    "WARNING",
    "ERROR",
    "CRITICAL",
] = "INFO"

log_path: str | None = None

subcommand: (
    CommandBacklog
    | CommandIndex
    | CommandProject
    | CommandSponsors
)

version: bool = False

Command to manage projects on GitHub and locally.

Attributes:

• subcommand (CommandProjectCreate | CommandProjectCheck | CommandProjectPyPIRegister) –

  The selected subcommand.

subcommand: (
    CommandProjectCreate
    | CommandProjectCheck
    | CommandProjectPyPIRegister
)

Command to check GitHub projects.

Methods:

• __call__ –

  Run the command.

__call__() -> int

Command to create public/insiders repositories.

Methods:

• __call__ –

  Run the command.

Attributes:

• copier_template (str | None) –

  Copier template to generate new projects with.

• copier_template_answers (dict[str, str] | None) –

  Copier template answers to use when generating a project.

• description (str) –

  Shared description.

• github_username (str | None) –

  GitHub username.

• insiders_namespace (str | None) –

  Namespace of the insiders repository.

• insiders_project_directory (Path) –

  Directory in which to clone the insiders repository.

• insiders_repository (str | None) –

  Name of the insiders repository.

• namespace (str) –

  Namespace of the public repository.

• post_creation_command (list[str] | None) –

  Command to run after creating the public repository.

• project_directory (Path) –

  Directory in which to clone the public repository.

• pypi_username (str | None) –

  PyPI username to register the project with.

• register_on_pypi (bool) –

  Whether to register the project on PyPI after creating it.

• repository (str) –

  Name of the public repository.

copier_template: str | None = None

copier_template_answers: dict[str, str] | None = None

description: str

github_username: str | None = None

insiders_namespace: str | None = None

insiders_project_directory: Path

insiders_repository: str | None = None

namespace: str

post_creation_command: list[str] | None = None

project_directory: Path

pypi_username: str | None = None

register_on_pypi: bool = False

repository: str

__call__() -> int

Command to register a project name on PyPI.

Methods:

• __call__ –

  Run the command.

Attributes:

• description (str) –

  Description of the project on PyPI.

• name (str) –

  Name to register.

• username (str) –

  Username on PyPI (your account).

description: str

name: str

username: str

__call__() -> Any

Command to manage sponsors.

Attributes:

• subcommand (CommandSponsorsList | CommandSponsorsShow | CommandSponsorsTeamList | CommandSponsorsTeamSync) –

  The selected subcommand.

subcommand: (
    CommandSponsorsList
    | CommandSponsorsShow
    | CommandSponsorsTeamList
    | CommandSponsorsTeamSync
)

Command to list sponsors.

Methods:

• __call__ –

  Run the command.

Attributes:

• exclude_users (list[str]) –

  Users that should never be in the team.

• github_beneficiaries (dict[str, list[str]]) –

  Beneficiaries of GitHub sponsors.

• github_sponsored_account (str) –

  The sponsored account on GitHub Sponsors.

• github_token (str) –

  A GitHub token. Recommended scopes: admin:org and read:user.

• include_users (list[str]) –

  Users that should always be in the team.

• minimum_amount (int) –

  Minimum amount to be considered an insider.

• polar_beneficiaries (dict[str, list[str]]) –

  Beneficiaries of Polar sponsors.

• polar_sponsored_account (str) –

  The sponsored account on Polar.

• polar_token (str) –

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

• public (bool) –

  Only use public sponsorships.

• sponsorships (bool) –

  List sponsorships rather than users/sponsors.

exclude_users: list[str] = field(default_factory=list)

github_beneficiaries: dict[str, list[str]] = field(
    default_factory=dict
)

github_sponsored_account: str = ''

github_token: str = ''

include_users: list[str] = field(default_factory=list)

minimum_amount: int = 0

polar_beneficiaries: dict[str, list[str]] = field(
    default_factory=dict
)

polar_sponsored_account: str = ''

polar_token: str = ''

public: bool = False

sponsorships: bool = False

__call__() -> int

Command to show details about a sponsor/user.

Methods:

• __call__ –

  Run the command.

Attributes:

• dry_run (bool) –

  Display the changes that would be made, without making them.

• exclude_users (list[str]) –

  Users that should never be in the team.

• github_beneficiaries (dict[str, list[str]]) –

  A mapping of users belonging to sponsoring organizations.

• github_sponsored_account (str) –

  The sponsored account on GitHub Sponsors.

• github_token (str) –

  A GitHub token. Recommended scopes: admin:org and read:user.

• include_users (list[str]) –

  Users that should always be in the team.

• insiders_team (str) –

  The GitHub team to sync.

• minimum_amount (int) –

  Minimum amount to be considered an insider.

• polar_sponsored_account (str) –

  The sponsored account on Polar.

• polar_token (str) –

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

dry_run: bool = False

exclude_users: list[str] = field(default_factory=list)

github_beneficiaries: dict[str, list[str]] = field(
    default_factory=dict
)

github_sponsored_account: str = ''

github_token: str = ''

include_users: list[str] = field(default_factory=list)

insiders_team: str

minimum_amount: int = 0

polar_sponsored_account: str = ''

polar_token: str = ''

__call__() -> int

Command to list team memberships.

Methods:

• __call__ –

  Run the command.

__call__() -> int

Command to sync team memberships with current sponsors.

Methods:

• __call__ –

  Run the command.

Attributes:

• dry_run (bool) –

  Display the changes that would be made, without making them.

• exclude_users (list[str]) –

  Users that should never be in the team.

• github_beneficiaries (dict[str, list[str]]) –

  A mapping of users belonging to sponsoring organizations.

• github_sponsored_account (str) –

  The sponsored account on GitHub Sponsors.

• github_token (str) –

  A GitHub token. Recommended scopes: admin:org and read:user.

• include_users (list[str]) –

  Users that should always be in the team.

• insiders_team (str) –

  The GitHub team to sync.

• minimum_amount (int) –

  Minimum amount to be considered an insider.

• polar_beneficiaries (dict[str, list[str]]) –

  Beneficiaries of Polar sponsors.

• polar_sponsored_account (str) –

  The sponsored account on Polar.

• polar_token (str) –

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

dry_run: bool = False

exclude_users: list[str] = field(default_factory=list)

github_beneficiaries: dict[str, list[str]] = field(
    default_factory=dict
)

github_sponsored_account: str = ''

github_token: str = ''

include_users: list[str] = field(default_factory=list)

insiders_team: str

minimum_amount: int = 0

polar_beneficiaries: dict[str, list[str]] = field(
    default_factory=dict
)

polar_sponsored_account: str = ''

polar_token: str = ''

__call__() -> int

Configuration for the insiders project.

Methods:

• from_default_location –

  Load configuration from the default location.

• from_file –

  Load configuration from a file.

Attributes:

• backlog_github_token (str | Unset) –

  Get the GitHub token for backlog operations.

• backlog_github_token_command (str | Unset) –

  Command to obtain a GitHub token for the backlog.

• backlog_issue_labels (dict[str, str] | Unset) –

  Map of label names to their display value (emojis, typically).

• backlog_limit (int | Unset) –

  Limit the number of displayed issues.

• backlog_namespaces (list[str] | Unset) –

  GitHub namespaces to fetch issues from.

• backlog_polar_token (str | Unset) –

  Get the Polar token for backlog operations.

• backlog_polar_token_command (str | Unset) –

  Command to obtain a Polar token for the backlog.

• backlog_sort (list[Callable] | Unset) –

  Sort strategies to apply to the backlog.

• index_distributions_directory (str | Unset) –

  Directory to store generated Python project distributions.

• index_log_path (str | Unset) –

  Where to write the index server logs to.

• index_sources_directory (str | Unset) –

  Directory to store project sources (cloned repositories).

• index_start_in_background (bool | Unset) –

  Whether to start the index server in the background.

• index_url (str | Unset) –

  URL of the index server.

• project_copier_template (str | Unset) –

  Copier template to generate new projects with.

• project_copier_template_answers (dict[str, str] | Unset) –

  Copier template answers to use when generating a project.

• project_directory (str | Unset) –

  Directory in which to clone created public projects.

• project_github_username (str | Unset) –

  GitHub username to use for operations.

• project_insiders_directory (str | Unset) –

  Directory in which to clone created private projects.

• project_insiders_namespace (str | Unset) –

  GitHub namespace to create insiders projects in.

• project_namespace (str | Unset) –

  GitHub namespace to create public projects in.

• project_post_creation_command (str | list[str] | Unset) –

  Command to run after creating a project.

• project_pypi_username (str | Unset) –

  PyPI username to use when registering projects on PyPI.

• project_register_on_pypi (bool | Unset) –

  Whether to register new projects on PyPI after creating them.

• sponsors_exclude_users (set[str] | Unset) –

  GitHub users to never include in the insiders team (even sponsors).

• sponsors_github_beneficiaries (dict[str, set[str]] | Unset) –

  Map of GitHub sponsors to their beneficiaries.

• sponsors_github_sponsored_account (str | Unset) –

  GitHub account receiving sponsorships.

• sponsors_github_token (str | Unset) –

  Get the GitHub token for sponsors operations.

• sponsors_github_token_command (str | Unset) –

  Command to obtain a GitHub token.

• sponsors_include_users (set[str] | Unset) –

  GitHub users to always include in the insiders team (even non-sponsors).

• sponsors_insiders_team (str | Unset) –

  GitHub team to add insiders to.

• sponsors_minimum_amount (int | Unset) –

  Minimum sponsorship amount to be considered an insider.

• sponsors_polar_beneficiaries (dict[str, set[str]] | Unset) –

  Map of Polar sponsors to their beneficiaries.

• sponsors_polar_sponsored_account (str | Unset) –

  Polar account receiving sponsorships.

• sponsors_polar_token (str | Unset) –

  Get the Polar token for sponsors operations.

• sponsors_polar_token_command (str | Unset) –

  Command to obtain a Polar token for the sponsors.

backlog_github_token: str | Unset

backlog_github_token_command: str | Unset = config_field(
    "backlog.github-token-command"
)

backlog_issue_labels: dict[str, str] | Unset = config_field(
    "backlog.issue-labels"
)

backlog_limit: int | Unset = config_field('backlog.limit')

backlog_namespaces: list[str] | Unset = config_field(
    "backlog.namespaces"
)

backlog_polar_token: str | Unset

backlog_polar_token_command: str | Unset = config_field(
    "backlog.polar-token-command"
)

backlog_sort: list[Callable] | Unset = config_field(
    "backlog.sort", transform="_eval_sort"
)

index_distributions_directory: str | Unset = config_field(
    "index.distributions-directory"
)

index_log_path: str | Unset = config_field("index.log-path")