Python: package yambs.github

yambs.github

index
/home/vkottler/src/vkottler/workspace/yambs/yambs/github/__init__.py

A module for working with GitHub releases.

Package Contents

Classes

vcorelib.dict.codec.BasicDictCodec(vcorelib.dict.codec.DictCodec)

Github(yambs.schemas.YambsDictCodec, vcorelib.dict.codec.BasicDictCodec)

yambs.schemas.YambsDictCodec(vcorelib.dict.codec.DictCodec)

Github(yambs.schemas.YambsDictCodec, vcorelib.dict.codec.BasicDictCodec)

class Github(yambs.schemas.YambsDictCodec, vcorelib.dict.codec.BasicDictCodec)

Github(data: Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]] = None, schemas: vcorelib.schemas.base.SchemaMap = None, dest_attr: str = 'data', verify: bool = True) -> None

GitHub repository information.

Method resolution order:: Github; yambs.schemas.YambsDictCodec; vcorelib.dict.codec.BasicDictCodec; vcorelib.dict.codec.DictCodec; vcorelib.dict.codec.JsonCodec; abc.ABC; vcorelib.schemas.mixins.SchemaMixin; builtins.object

Data and other attributes defined here:

__abstractmethods__ = frozenset()

__annotations__ = {}

Data and other attributes inherited from yambs.schemas.YambsDictCodec:

default_schemas = {'Variant': <vcorelib.schemas.json.JsonSchema ob...chemas.json.JsonSchema object at 0x7f0995b21a30>}

Methods inherited from vcorelib.dict.codec.BasicDictCodec:

asdict(self) -> Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]]: Obtain a dictionary representing this instance.

init(self, data: Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]]) -> None: Initialize this instance.

Methods inherited from vcorelib.dict.codec.DictCodec:

__init__(self, data: Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]] = None, schemas: vcorelib.schemas.base.SchemaMap = None, dest_attr: str = 'data', verify: bool = True) -> None: Initialize this instance.

Class methods inherited from vcorelib.dict.codec.DictCodec:

create(data: Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]] = None, schemas: vcorelib.schemas.base.SchemaMap = None, dest_attr: str = 'data', verify: bool = True) -> ~V from abc.ABCMeta: A factory method to create an instance.

Methods inherited from vcorelib.dict.codec.JsonCodec:

__copy__(self: ~T) -> ~T: Create another instance based on this instance's data.

__eq__(self, other) -> bool: Determine if this instance is equal to another.

__str__(self) -> str: Use the dictionary representation of this instance for string
representation.

encode(self, pathlike: Union[pathlib.Path, str, NoneType], arbiter: vcorelib.io.arbiter.DataArbiter = <vcorelib.io.arbiter.DataArbiter object at 0x7f0994d5b140>, **kwargs) -> Tuple[bool, int]: Encode this object instance to a file.

Class methods inherited from vcorelib.dict.codec.JsonCodec:

decode(pathlike: Union[pathlib.Path, str, NoneType], arbiter: vcorelib.io.arbiter.DataArbiter = <vcorelib.io.arbiter.DataArbiter object at 0x7f0994d5b140>, schemas: vcorelib.schemas.base.SchemaMap = None, dest_attr: str = 'data', verify: bool = True, require_success: bool = True, default_data: Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]] = None, **kwargs) -> ~T from abc.ABCMeta: Decode an object instance from data loaded from a file.

file_cache(pathlike: Union[pathlib.Path, str, NoneType], arbiter: vcorelib.io.arbiter.DataArbiter = <vcorelib.io.arbiter.DataArbiter object at 0x7f0994d5b140>, encode_kwargs: Dict[str, Any] = None, require_success: bool = False, **kwargs) -> Iterator[~T] from abc.ABCMeta: Manage an instance of this class as a disk-backed file.

normalize(data: Union[Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]], ~T]) -> ~T from abc.ABCMeta: Ensure that some object is an instance of this class.

Data descriptors inherited from vcorelib.dict.codec.JsonCodec:

__dict__: dictionary for instance variables

__weakref__: list of weak references to the object

Data and other attributes inherited from vcorelib.dict.codec.JsonCodec:

__hash__ = None

Methods inherited from vcorelib.schemas.mixins.SchemaMixin:

validate(self, valid_attr: str = 'data') -> None: Validate an instance attribute based on this instance's schema.

Class methods inherited from vcorelib.schemas.mixins.SchemaMixin:

schema_name() -> str from abc.ABCMeta: A default name for this class's schema.

Functions

check_api_token() -> None: Check for a GitHub API token set via the environment.

github_url(netloc_prefix: str = '', scheme: str = 'https', path: str = '', params: str = '', query: str = '', fragment: str = '') -> urllib.parse.ParseResult: See: https://docs.python.org/3/library/urllib.parse.html.

release_data(owner: str, repo: str, *args, version: str = 'latest', timeout: float = None, **kwargs) -> Dict[str, Any]: Get latest-release data.

repo_release_api_url(owner: str, repo: str, version: str = 'latest') -> str: Get a URL string for a repository's latest release.

validate_release(data: Dict[str, Any]) -> bool: Ensure that GitHub release data actually contains data.

Data
		DEFAULT_RELEASE = 'latest' Dict = typing.Dict GIHTUB_HEADERS = {'Accept': 'application/vnd.github+json', 'X-GitHub-Api-Version': '2022-11-28'} ReleaseData = typing.Dict[str, typing.Any]