mac_maker.utilities.github

GitHub Repository representation.

exception mac_maker.utilities.github.GithubCommunicationError

Raised when a remote Github repository cannot be accessed.

class mac_maker.utilities.github.GithubRepository(repository)

GitHub Repository representation.

Parameters

repository (str) – The http or ssh URL of the repository.

download_zip_bundle_profile(file_system_target, branch_name)

Download a zip bundle for the branch, then unzip everything.

Parameters

• branch_name (Optional[str]) – The branch of the repository to use.

• file_system_target (Union[Path, str]) – The destination path to unzip the bundle to.

Return type

None

get_branch_name(branch_name)

Return the given branch name, or the default branch.

Parameters

branch_name (Optional[str]) – The branch of the repository to use.

Return type

str

Returns

The given branch name, or the default branch.

get_http_url()

Return the http url for the repository.

Return type

str

Returns

The http url of the repository.

get_org_name()

Return Github’s org (or user) name for the repository.

Return type

str

Returns

The org (or user) name of the repository.

get_repo_name()

Return Github’s name for the repository.

Return type

str

Returns

The name of the repository.

get_ssh_url()

Return the ssh url for the repository.

Return type

str

Returns

The ssh url of the repository.

get_zip_bundle_root_folder(branch_name)

Return the top level folder inside a repo’s zip bundle.

Parameters

branch_name (Optional[str]) – The branch of the repository to use.

Return type

str

Returns

The top level folder inside a repo’s zip bundle.

get_zip_bundle_url(branch_name)

Generate a zipfile url for the given branch.

Parameters

branch_name (Optional[str]) – The branch of the repository to use.

Return type

str

Returns

The url of the zipfile bundle for this branch.

exception mac_maker.utilities.github.InvalidGithubRepository

Raised when a Github repository URL cannot be parsed.