Python: module yambs.dependency.github

yambs.dependency.github

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

A module implementing GitHub dependency interactions.

Modules

requests

Classes

vcorelib.logging.LoggerMixin(builtins.object)

GithubDependency

class GithubDependency(vcorelib.logging.LoggerMixin)

GithubDependency(owner: str, repo: str, *args, version: str = 'latest', data: Dict[str, Any] = None, **kwargs) -> None

A class for managing GitHub dependencies.

Method resolution order:: GithubDependency; vcorelib.logging.LoggerMixin; builtins.object

Methods defined here:

__init__(self, owner: str, repo: str, *args, version: str = 'latest', data: Dict[str, Any] = None, **kwargs) -> None: Initialize this instance.

download_release_assets(self, filt: Callable[[dict[str, Any]], Optional[pathlib.Path]], extract: bool = True) -> None: Ensure release assets are downloaded.

Data and other attributes defined here:

__annotations__ = {}

Methods inherited from vcorelib.logging.LoggerMixin:

log_time(self, message: str, *args, level: int = 20, reminder: bool = False, **kwargs) -> Iterator[NoneType]: A simple wrapper.

Data descriptors inherited from vcorelib.logging.LoggerMixin:

__dict__: dictionary for instance variables

__weakref__: list of weak references to the object

Functions

default_filt(output: pathlib.Path, pattern: str = '.*', mkdir: bool = True) -> Callable[[dict[str, Any]], Optional[pathlib.Path]]: Create a default release-asset filter method.

download_file_if_missing(uri: str, dest: pathlib.Path, timeout: float = 10.0, chunk_size: int = 4096) -> None: Download a file if necessary.

ensure_extracted(path: pathlib.Path, logger: Union[logging.Logger, logging.LoggerAdapter[Any]] = None) -> None: Ensure that all archive files in a directory are extracted.

Data
		AssetFilter = typing.Callable[[dict[str, typing.Any]], typing.Optional[pathlib.Path]] Callable = typing.Callable DEFAULT_RELEASE = 'latest' Dict = typing.Dict LoggerType = typing.Union[logging.Logger, logging.LoggerAdapter[typing.Any]] Optional = typing.Optional ReleaseData = typing.Dict[str, typing.Any]