api.wheel_sources.github.GithubReleaseBinarySource

class documentation

class GithubReleaseBinarySource(WheelSource):

Constructor: GithubReleaseBinarySource(project_slug, version, asset_name_mapping, binary_path, ...)

Provide source from GitHub Release API

Method	`__init__`	No summary
Method	`generate_fileset`	Undocumented
Instance Variable	`asset_name_mapping`	Undocumented
Instance Variable	`binary_path`	Undocumented
Instance Variable	`project_slug`	Undocumented
Instance Variable	`tag_prefix`	Undocumented
Instance Variable	`token`	Undocumented
Instance Variable	`version`	Undocumented

def __init__(self, project_slug: str, version: str, asset_name_mapping: dict[WheelPlatformIdentifier, str], binary_path: str, tag_prefix: str = 'v', token: str | None = None): ¶

Parameters
project_slug:`str`	Full name of the project e.g. user/project or org/project
version:`str`	Version of the release
asset_name_mapping:`dict[WheelPlatformIdentifier, str]`	Mapping of GitHub Release assets to the corresponding wheel platform
binary_path:`str`	Path to the binary file in the generated wheel
tag_prefix:`str`	Prefix for release tag which will be prepended to version for the version
token:`str \| None`	Optional token in case you want to access a private repository

def generate_fileset(self, wheel_platform: WheelPlatformIdentifier) -> list[WheelFileEntry]: ¶

Undocumented

asset_name_mapping = ¶

Undocumented

binary_path = ¶

Undocumented

project_slug = ¶

Undocumented

tag_prefix = ¶

Undocumented

token = ¶

Undocumented

version = ¶

Undocumented