runway.sources.git module

‘Git type Path Source.

class runway.sources.git.Git(*, arguments: Optional[Dict[str, str]] = None, location: str = '', uri: str = '', **kwargs: Any)[source]

Bases: runway.sources.source.Source

Git Path Source.

The Git path source can be tasked with cloning a remote repository and pointing to a specific module folder (or the root).

Git Path Source.

  • arguments – A reference can be passed along via the arguments so that a specific version of the repository is cloned. commit, tag, branch are all valid keys with respective output

  • location – The relative location to the root of the repository where the module resides. Leaving this as an empty string, /, or ./ will have runway look in the root folder.

  • uri – The uniform resource identifier that targets the remote git repository


Retrieve the git repository from it’s remote location.

classmethod sanitize_git_path(path: str)str[source]

Sanitize the git path for folder/file assignment.

Keyword Arguments

path – The path string to be sanitized

static sanitize_directory_path(uri: str)str

Sanitize a Source directory path string.


uri – The uniform resource identifier when targetting a remote resource.