Skip to content

archive

Accessed as client.repos.archive; the async client mirrors it.

ReposArchive

The repos.archive namespace.

get

get(owner: str, repo: str, archive: str) -> bytes

Get an archive of a repository.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required
archive str

the git reference for download with attached archive format (e.g. master.zip)

required

Returns:

Type Description
bytes

success.

Raises:

Type Description
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: repoGetArchive

AsyncReposArchive

The repos.archive namespace.

get

get(owner: str, repo: str, archive: str) -> bytes

Get an archive of a repository.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required
archive str

the git reference for download with attached archive format (e.g. master.zip)

required

Returns:

Type Description
bytes

success.

Raises:

Type Description
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: repoGetArchive