pygit2_clone_repo.md

PyGit2 Clone Repository

Cloning a git repository with PyGit2, via https + access token (i.e. use x-oauth-basic):

git_token = "your access token"
git_repo_path = "Repository path"
git_repo_url = (
    f"https://{git_token}:[email protected]/{git_repo_path}"
)
cloned_repo = pygit2.clone_repository(git_repo_url, "path/to/clone/to")

To checkout a specific branch after cloning:

git_token = "your access token"
git_repo_path = "Repository path"
git_repo_url = (
    f"https://{git_token}:[email protected]/{git_repo_path}"
)
cloned_repo = pygit2.clone_repository(git_repo_url, "path/to/clone/to")
branch_name="uat"
branch_name=f"origin/{branch}"
branch_origin=cloned_repo.branches[branch_name]
branch_ref=cloned_repo.lookup_reference(branch_origin.name)
cloned_repo.checkout(branch_ref)

Cloning with a RemoteCallback

# The token must be the git token
clone_path = f"../{path}"
shutil.rmtree(clone_path, ignore_errors=True)
callbacks = pygit2.RemoteCallbacks(pygit2.UserPass('x-oauth-basic', token))
cloned_repo = pygit2.clone_repository(repo_url, clone_path, callbacks=callbacks, checkout_branch=branch)