qwikstart.repository package

Submodules

qwikstart.repository.core module

class qwikstart.repository.core.TaskSpec

Bases: dict

qwikstart.repository.git module

class qwikstart.repository.git.GitUrl(prefix, separator, raw_path)

Bases: tuple

path

prefix

Alias for field number 0

raw_path

Alias for field number 2

separator

Alias for field number 1

qwikstart.repository.git.download_git_repo(repo_url: str, local_path: pathlib.Path) → None

qwikstart.repository.git.get_local_repo_path(url: str) → pathlib.Path

qwikstart.repository.git.parse_git_url(url: str) → Optional[qwikstart.repository.git.GitUrl]

qwikstart.repository.git.resolve_git_url(url: str) → str

qwikstart.repository.git.sync_git_repo_locally(git_url: str) → pathlib.Path

Download or update local copy of git repo and return local path.

qwikstart.repository.git.update_git_repo(local_path: pathlib.Path) → None

qwikstart.repository.loaders module

class qwikstart.repository.loaders.BaseRepoLoader

Bases: abc.ABC

Base class for loader for qwikstart task repos.

repo_path

Return local path to qwikstart repo.

task_spec

Return raw task specification loaded from qwikstart repo.

class qwikstart.repository.loaders.GitRepoLoader(git_url: str, path: str = '')

Bases: qwikstart.repository.loaders.BaseRepoLoader

Loader for qwikstart task repos stored in git repos.

repo_path

Return local path to qwikstart repo.

task_spec

Return raw task specification loaded from qwikstart repo.

class qwikstart.repository.loaders.RepoLoader(url_or_path: str = '')

Bases: qwikstart.repository.loaders.BaseRepoLoader

Loader for qwikstart task spec.

The task spec must specify a source url for the location of the qwikstart repo.

repo_path

Return local path to qwikstart repo.

task_spec

Return raw task specification loaded from qwikstart repo.

Module contents

class qwikstart.repository.BaseRepoLoader

Bases: abc.ABC

Base class for loader for qwikstart task repos.

repo_path

Return local path to qwikstart repo.

task_spec

Return raw task specification loaded from qwikstart repo.

class qwikstart.repository.GitRepoLoader(git_url: str, path: str = '')

Bases: qwikstart.repository.loaders.BaseRepoLoader

Loader for qwikstart task repos stored in git repos.

repo_path

Return local path to qwikstart repo.

task_spec

Return raw task specification loaded from qwikstart repo.

class qwikstart.repository.RepoLoader(url_or_path: str = '')

Bases: qwikstart.repository.loaders.BaseRepoLoader

Loader for qwikstart task spec.

The task spec must specify a source url for the location of the qwikstart repo.

repo_path

Return local path to qwikstart repo.

task_spec

Return raw task specification loaded from qwikstart repo.

class qwikstart.repository.TaskSpec

Bases: dict