Movatterモバイル変換

auto_trigger_checks(app_id,enabled=True)

Change preferences for automatic creation of check suites.

New in version 1.3.0.

Enable/disable the automatic flow when creating check suites.By default, the check suite is automatically created each time codeis pushed. When the automatic creation is disable they can be createdmanually.

Parameters:

app_id (int) – (required), the id of the GitHub App
enabled (bool) – (optional), enable automatic creation of check suitesDefault: True

Returns:

the check suite settings for this repository

Return type:

dict

blob(sha)

Get the blob indicated bysha.

Parameters:: sha (str) – (required), sha of the blob
Returns:: the git blob
Return type:: Blob

branch(name)

Get the branchname of this repository.

Parameters:: name (str) – (required), branch name
Returns:: the branch
Return type:: Branch

branches(number=-1,protected=False,etag=None)

Iterate over the branches in this repository.

Parameters:

number (int) – (optional), number of branches to return. Default: -1 returns allbranches
protected (bool) – (optional), True lists only protected branches.Default: False
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of branches

Return type:

Branch

check_run(id)

Return a single check run.

New in version 1.3.0.

Parameters:: id (int) – (required), id of the check run
Returns:: the check run
Return type:: CheckRun

check_suite(id)

Return a single check suite.

New in version 1.3.0.

Parameters:: id (int) – (required), id of the check suite
Returns:: the check suite
Return type:: CheckSuite

clones(per='day')

Get the total number of repository clones and breakdown per day orweek for the last 14 days.

New in version 1.4.0.

Parameters:: per (str) – (optional), (‘day’, ‘week’), clones reporting period. Default ‘day’will return clones per day for the last 14 days.
Returns:: clones data
Return type:: ClonesStats
Raises:: ValueError if per is not a valid choice

code_frequency(number=-1,etag=None)

Iterate over the code frequency per week.

New in version 0.7.

Returns a weekly aggregate of the number of additions and deletionspushed to this repository.

Note

All statistics methods may return a 202. On those occasions,you will not receive any objects. You should store youriterator and check the newlast_status attribute. If itis a 202 you should wait before re-requesting.

Parameters:

number (int) – (optional), number of weeks to return. Default: -1returns all weeks
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of lists[seconds_from_epoch,additions,deletions]

Return type:

list

collaborators(affiliation='all',number=-1,etag=None)

Iterate over the collaborators of this repository.

Parameters:

affiliation (str) – (optional), affiliation of the collaborator to the repository.Default: “all” returns contributors with all affiliations
number (int) – (optional), number of collaborators to return.Default: -1 returns all comments
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of collaborators

Return type:

Collaborator

comments(number=-1,etag=None)

Iterate over comments on all commits in the repository.

Parameters:

number (int) – (optional), number of comments to return. Default:-1 returns all comments
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of comments on commits

Return type:

See:http://developer.github.com/v3/repos/statistics/

commit(sha)

Get a single (repo) commit.

Seegit_commit() for the Git Data Commit.

Parameters:: sha (str) – (required), sha of the commit
Returns:: the commit
Return type:: RepoCommit

commit_activity(number=-1,etag=None)

Iterate over last year of commit activity by week.

New in version 0.7.

Note

Parameters:

number (int) – (optional), number of weeks to return. Default -1will return all of the weeks.
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of dictionaries

Return type:

dict

commit_comment(comment_id)

Get a single commit comment.

Parameters:: comment_id (int) – (required), id of the comment used by GitHub
Returns:: the comment on the commit
Return type:: RepoComment

commits(sha=None,path=None,author=None,number=-1,etag=None,since=None,until=None,per_page=None)

Iterate over commits in this repository.

Parameters:

sha (str) – (optional), sha or branch to start listing commits from
path (str) – (optional), commits containing this path will be listed
author (str) – (optional), GitHub login, real name, or email tofilter commits by (using commit author)
number (int) – (optional), number of commits to return. Default:-1 returns all commits
etag (str) – (optional), ETag from a previous request to the same endpoint
since (datetime or str) – (optional), Only commits after this date will be returned.This can be adatetime or anISO8601 formatteddate string.
until (datetime or str) – (optional), Only commits before this date willbe returned. This can be adatetime or anISO8601 formatteddate string.
per_page (int) – (optional), commits listing page size

Returns:

generator of commits

Return type:

compare_commits(base,head)

Compare two commits.

Parameters:

base (str) – (required), base for the comparison
head (str) – (required), compare this against base

Returns:

the comparison of the commits

Return type:

Comparison

contributor_statistics(number=-1,etag=None)

Iterate over the contributors list.

New in version 0.7.

Note

Parameters:

number (int) – (optional), number of weeks to return. Default -1will return all of the weeks.
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of contributor statistics for each contributor

Return type:

ContributorStats

contributors(anon=False,number=-1,etag=None)

Iterate over the contributors to this repository.

Parameters:

anon (bool) – (optional), True lists anonymous contributors as well
number (int) – (optional), number of contributors to return.Default: -1 returns all contributors
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of contributor users

Return type:

Contributor

create_blob(content,encoding)

Create a blob withcontent.

Parameters:

content (str) – (required), content of the blob
encoding (str) – (required), (‘base64’, ‘utf-8’)

Returns:

string of the SHA returned

Returns:

str

create_branch_ref(name,sha=None)

Create a branch git reference.

This is a shortcut for callinggithub3.repos.repo.Repository.create_ref().

Parameters:

branch (str) – (required), the branch to create
sha (str) – the commit to base the branch from

Returns:

a reference object representing the branch

Return type:

create_check_run(name,head_sha,details_url=None,external_id=None,started_at=None,status=None,conclusion=None,completed_at=None,output=None,actions=None)

Create a check run object on a commit

New in version 1.3.0.

Parameters:

name (str) – (required), The name of the check
head_sha (str) – (required), The SHA of the commit
details_url (str) – (optional), The URL of the integrator’s site that has the fulldetails of the check
external_id (str) – (optional), A reference for the run on the integrator’s system
started_at (str) – (optional), ISO 8601 time format: YYYY-MM-DDTHH:MM:SSZ
status (str) – (optional), (‘queued’, ‘in_progress’, ‘completed’)
conclusion (str) – (optional), Required if you provide ‘completed_at’, or a‘status’ of ‘completed’. The final conclusion of the check.(‘success’, ‘failure’, ‘neutral’, ‘cancelled’, ‘timed_out’,‘action_required’)
completed_at (str) – (optional), Required if you provide ‘conclusion’. ISO 8601 timeformat: YYYY-MM-DDTHH:MM:SSZ
output (dict) – (optional), key-value pairs representing the output. Format:{'title':'string','summary':'text,canbemarkdown','text':'text,canbemarkdown','annotations':[{}],'images':[{}]}
actions (list) – (optional), list of action objects. Format is:[{'label':'text','description','text','identifier','text'},...]

Returns:

the created check run

Return type:

CheckRun

create_check_suite(head_sha)

Create a check suite object on a commit

New in version 1.3.0.

Parameters:: head_sha (str) – The sha of the head commit.
Returns:: the created check suite
Return type:: CheckSuite

create_comment(body,sha,path=None,position=None,line=1)

Create a comment on a commit.

Parameters:

body (str) – (required), body of the message
sha (str) – (required), commit id
path (str) – (optional), relative path of the file to comment on
position (str) – (optional), line index in the diff to comment on
line (int) – (optional), line number of the file to comment on, default: 1

Returns:

the created comment

Return type:

create_commit(message,tree,parents,author=None,committer=None)

Create a commit on this repository.

Parameters:

message (str) – (required), commit message
tree (str) – (required), SHA of the tree object this commit points to
parents (list) – (required), SHAs of the commits that were parentsof this commit. If empty, the commit will be written as the rootcommit. Even if there is only one parent, this should be anarray.
author (dict) – (optional), if omitted, GitHub willuse the authenticated user’s credentials and the currenttime. Format: {‘name’: ‘Committer Name’, ‘email’:‘name@example.com’, ‘date’: ‘YYYY-MM-DDTHH:MM:SS+HH:00’}
committer (dict) – (optional), if ommitted, GitHub will use theauthor parameters. Should be the same format as the authorparameter.

Returns:

the created commit

Return type:

Commit

create_deployment(ref,required_contexts=None,payload='',auto_merge=False,description='',environment=None)

Create a deployment.

Parameters:

ref (str) – (required), The ref to deploy. This can be a branch, tag, or sha.
required_contexts (list) – Optional array of status contextsverified against commit status checks. To bypass checkingentirely pass an empty array. Default: []
payload (str) – Optional JSON payload with extra information aboutthe deployment. Default: “”
auto_merge (bool) – Optional parameter to merge the default branchinto the requested deployment branch if necessary. Default: False
description (str) – Optional short description. Default: “”
environment (str) – Optional name for the target deploymentenvironment (e.g., production, staging, qa). Default: “production”

Returns:

the created deployment

Return type:

create_file(path,message,content,branch=None,committer=None,author=None)

Create a file in this repository.

Parameters:

path (str) – (required), path of the file in the repository
message (str) – (required), commit message
content (bytes) – (required), the actual data in the file
branch (str) – (optional), branch to create the commit on.Defaults to the default branch of the repository
committer (dict) – (optional), if no information is given theauthenticated user’s information will be used. You must specifyboth a name and email.
author (dict) – (optional), if omitted this will be filled in withcommitter information. If passed, you must specify both a name andemail.

Returns:

dictionary of contents and commit for created file

Return type:

Contents,Commit

create_fork(organization=None)

Create a fork of this repository.

Parameters:: organization (str) – (required), login for organization to create the fork under
Returns:: the fork of this repository
Return type:: Repository

create_hook(name,config,events=['push'],active=True)

Create a hook on this repository.

Parameters:

name (str) – (required), name of the hook
config (dict) – (required), key-value pairs which act as settings for this hook
events (list) – (optional), events the hook is triggered for
active (bool) – (optional), whether the hook is actually triggered

Returns:

the created hook

Return type:

create_issue(title,body=None,assignee=None,milestone=None,labels=None,assignees=None)

Create an issue on this repository.

Parameters:

title (str) – (required), title of the issue
body (str) – (optional), body of the issue
assignee (str) – (optional), login of the user to assign the issue to
milestone (int) – (optional), id number of the milestone toattribute this issue to (e.g.m is aMilestone object,m.numberis what you pass here.)
labels ([str]) – (optional), labels to apply to this issue
assignees ([str]) – (optional), login of the users to assign the issue to

Returns:

the created issue

Return type:

ShortIssue

create_key(title,key,read_only=False)

Create a deploy key.

Parameters:

title (str) – (required), title of key
key (str) – (required), key text
read_only (bool) – (optional), restrict key access to read-only, default is False

Returns:

the created key

Return type:

create_label(name,color,description=None)

Create a label for this repository.

Parameters:

name (str) – (required), name to give to the label
color (str) – (required), value of the color to assign to thelabel, e.g., ‘#fafafa’ or ‘fafafa’ (the latter is what is sent)
description (str) – (optional), description to give to the label

Returns:

the created label

Return type:

create_milestone(title,state=None,description=None,due_on=None)

Create a milestone for this repository.

Parameters:

title (str) – (required), title of the milestone
state (str) – (optional), state of the milestone, acceptedvalues: (‘open’, ‘closed’), default: ‘open’
description (str) – (optional), description of the milestone
due_on (str) – (optional), ISO 8601 formatted due date

Returns:

the created milestone

Return type:

create_project(name,body=None)

Create a project for this repository.

Parameters:

name (str) – (required), name of the project
body (str) – (optional), body of the project

Returns:

the created project

Return type:

create_pull(title,base,head,body=None,maintainer_can_modify=None)

Create a pull request ofhead ontobase branch in this repo.

Parameters:

title (str) – (required)
base (str) – (required), e.g., ‘master’
head (str) – (required), e.g., ‘username:branch’
body (str) – (optional), markdown formatted description
maintainer_can_modify (bool) – (optional), Indicates whether a maintainer is allowed to modify thepull request or not.

Returns:

the created pull request

Return type:

create_pull_from_issue(issue,base,head)

Create a pull request from issue #``issue``.

Parameters:

issue (int) – (required), issue number
base (str) – (required), e.g., ‘master’
head (str) – (required), e.g., ‘username:branch’

Returns:

the created pull request

Return type:

create_ref(ref,sha)

Create a reference in this repository.

Parameters:

ref (str) – (required), fully qualified name of the reference,e.g.refs/heads/master. If it doesn’t start withrefs andcontain at least two slashes, GitHub’s API will reject it.
sha (str) – (required), SHA1 value to set the reference to

Returns:

the created ref

Return type:

create_release(tag_name,target_commitish=None,name=None,body=None,draft=False,prerelease=False)

Create a release for this repository.

Parameters:

tag_name (str) – (required), name to give to the tag
target_commitish (str) – (optional), vague concept of a target, either a SHA or a branchname.
name (str) – (optional), name of the release
body (str) – (optional), description of the release
draft (bool) – (optional), whether this release is a draft or not
prerelease (bool) – (optional), whether this is a prerelease or not

Returns:

the created release

Return type:

create_status(sha,state,target_url=None,description=None,context='default')

Create a status object on a commit.

Parameters:

sha (str) – (required), SHA of the commit to create the status on
state (str) – (required), state of the test; only the followingare accepted: ‘pending’, ‘success’, ‘error’, ‘failure’
target_url (str) – (optional), URL to associate with this status.
description (str) – (optional), short description of the status
context (str) – (optional), A string label to differentiate thisstatus from the status of other systems

Returns:

the created status

Return type:

create_tag(tag,message,sha,obj_type,tagger,lightweight=False)

Create a tag in this repository.

By default, this method creates an annotated tag. If you wish tocreate a lightweight tag instead, passlightweight=True.

If you are creating an annotated tag, this method makes2 calls tothe API:

Creates the tag object
Creates the reference for the tag

This behaviour is required by the GitHub API.

Parameters:

tag (str) – (required), name of the tag
message (str) – (required), tag message
sha (str) – (required), SHA of the git object this is tagging
obj_type (str) – (required), type of object being tagged, e.g., ‘commit’, ‘tree’,‘blob’
tagger (dict) – (required), containing the name, email of thetagger and optionally the date it was tagged
lightweight (bool) – (optional), if False, create an annotatedtag, otherwise create a lightweight tag (a Reference).

Returns:

if creating a lightweight tag, this will return aReference, otherwise it will return aTag

Return type:

Tag orReference

create_tree(tree,base_tree=None)

Create a tree on this repository.

Parameters:

tree (list) – (required), specifies the tree structure.Format: [{‘path’: ‘path/file’, ‘mode’:‘filemode’, ‘type’: ‘blob or tree’, ‘sha’: ‘44bfc6d…’}]
base_tree (str) – (optional), SHA1 of the tree you want to update with new data

Returns:

the created tree

Return type:

delete()

Delete this repository.

Returns:: True if successful, False otherwise
Return type:: bool

delete_key(key_id)

Delete the key with the specified id from your deploy keys list.

Returns:: True if successful, False otherwise
Return type:: bool

delete_subscription()

Delete the user’s subscription to this repository.

Returns:: True if successful, False otherwise
Return type:: bool

deployment(id)

Retrieve the deployment identified byid.

Parameters:: id (int) – (required), id for deployments.
Returns:: the deployment
Return type:: Deployment

deployments(number=-1,etag=None)

Iterate over deployments for this repository.

Parameters:

number (int) – (optional), number of deployments to return.Default: -1, returns all available deployments
etag (str) – (optional), ETag from a previous request for all deployments

Returns:

generator of deployments

Return type:

directory_contents(directory_path,ref=None,return_as=<class'list'>)

Get the contents of each file indirectory_path.

If the path provided is actually a directory, you will receive alist back of the form:

[('filename.md',Contents(...)),('github.py',Contents(...)),# ...('fiz.py',Contents(...))]

You can either then transform it into a dictionary:

contents=dict(repo.directory_contents('path/to/dir/'))

Or you can use thereturn_as parameter to have it return adictionary for you:

contents=repo.directory_contents('path/to/dir/',return_as=dict)

Parameters:

path (str) – (required), path to file, e.g. github3/repos/repo.py
ref (str) – (optional), the string name of a commit/branch/tag.Default: master
return_as – (optional), how to return the directory’s contents.Default:list

Returns:

list of tuples of the filename and the Contents returned

Return type:

[(str,Contents)]

Raises:

github3.exceptions.UnprocessableResponseBody – When the requested directory is not actually a directory

edit(name,description=None,homepage=None,private=None,has_issues=None,has_wiki=None,has_downloads=None,default_branch=None,archived=None,allow_merge_commit=None,allow_squash_merge=None,allow_rebase_merge=None,has_projects=None)

Edit this repository.

Parameters:

name (str) – (required), name of the repository
description (str) – (optional), If notNone, change thedescription for this repository. API default:None - leavevalue unchanged.
homepage (str) – (optional), If notNone, change the homepagefor this repository. API default:None - leave value unchanged.
private (bool) – (optional), IfTrue, make the repositoryprivate. IfFalse, make the repository public. API default:None - leave value unchanged.
has_issues (bool) – (optional), IfTrue, enable issues forthis repository. IfFalse, disable issues for this repository.API default:None - leave value unchanged.
has_wiki (bool) – (optional), IfTrue, enable the wiki forthis repository. IfFalse, disable the wiki for thisrepository. API default:None - leave value unchanged.
has_downloads (bool) – (optional), IfTrue, enable downloadsfor this repository. IfFalse, disable downloads for thisrepository. API default:None - leave value unchanged.
default_branch (str) – (optional), If notNone, change thedefault branch for this repository. API default:None - leavevalue unchanged.
archived (bool) – (optional), If notNone, toggle the archivedattribute on the repository to control whether it is archived ornot.
allow_rebase_merge (bool) – (optional), If notNone, change whether the merge strategythat allows adding all commits from the head branch onto the basebranch individually is enabled for this repository. API default:None - leave value unchanged.
allow_squash_merge (bool) – (optional), If notNone, change whether combining all commitsfrom the head branch into a single commit in the base branch isallowed. API default:None - leave value unchanged.
allow_merge_commit (bool) – (optional), If notNone, change whether adding all commitsfrom the head branch to the base branch with a merge commit isallowed. API default:None - leave value unchanged.
has_projects (bool) – (optional), IfTrue, enable projects for this repository.IfFalse, disable projects projects for this repository.API default:None - leave value unchanged.

Returns:

True if successful, False otherwise

Return type:

bool

events(number=-1,etag=None)

Iterate over events on this repository.

Parameters:

number (int) – (optional), number of events to return. Default: -1returns all available events
etag (str) – (optional), ETag from a previous request to the sameendpoint

Returns:

generator of events

Return type:

file_contents(path,ref=None)

Get the contents of the file pointed to bypath.

Parameters:

path (str) – (required), path to file, e.g. github3/repos/repo.py
ref (str) – (optional), the string name of a commit/branch/tag.Default: master

Returns:

the contents of the file requested

Return type:

Contents

forks(sort='',number=-1,etag=None)

Iterate over forks of this repository.

Parameters:

sort (str) – (optional), accepted values:(‘newest’, ‘oldest’, ‘stargazers’), API default: ‘newest’
number (int) – (optional), number of forks to return. Default: -1returns all forks
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of forks of this repository

Return type:

ShortRepository

classmethodfrom_dict(json_dict,session): Return an instance of this class formed fromjson_dict.

classmethodfrom_json(json,session): Return an instance of this class formed fromjson.

git_commit(sha)

Get a single (git) commit.

Parameters:: sha (str) – (required), sha of the commit
Returns:: the single commit data from git
Return type:: Commit

hook(hook_id)

Get a single hook.

Parameters:: hook_id (int) – (required), id of the hook
Returns:: the hook
Return type:: Hook

hooks(number=-1,etag=None)

Iterate over hooks registered on this repository.

Parameters:

number (int) – (optional), number of hoks to return. Default: -1returns all hooks
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of hooks

Return type:

ignore()

Ignore notifications from this repository for the user.

New in version 1.0.

This replacesRepository#set_subscription.

Returns:: the new repository subscription
Return type:: :class:~github3.notifications.RepositorySubscription`

import_issue(title,body,created_at,assignee=None,milestone=None,closed=None,labels=None,comments=None)

Import an issue into the repository.

Parameters:

title (string) – (required) Title of issue
body (string) – (required) Body of issue
created_at (datetime or str) – (required) Creation timestamp
assignee (string) – (optional) Username to assign issue to
milestone (int) – (optional) Milestone ID
closed (boolean) – (optional) Status of issue is Closed if True
labels (list) – (optional) List of labels containing string names
comments (list) – (optional) List of dictionaries which containcreated_at and body attributes

Returns:

the imported issue

Return type:

imported_issue(imported_issue_id)

Retrieve imported issue specified by imported issue id.

Parameters:: imported_issue_id (int) – (required) id of imported issue
Returns:: the imported issue
Return type:: ImportedIssue

imported_issues(number=-1,since=None,etag=None)

Retrieve the collection of imported issues via the API.

Parameters:

number (int) – (optional), number of imported issues to return.Default: -1 returns all branches
since – (optional), Only imported issues after this date willbe returned. This can be adatetime instance, ISO8601formatted date string, or a string formatted like so:2016-02-04 i.e.%Y-%m-%d
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of imported issues

Return type:

invitations(number=-1,etag=None)

Iterate over the invitations to this repository.

Parameters:

number (int) – (optional), number of invitations to return. Default: -1 returnsall available invitations
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of repository invitation objects

Return type:

Invitation

is_assignee(username)

Check if the user can be assigned an issue on this repository.

Parameters:: username (str orUser) – name of the user to check
Returns:: bool

is_collaborator(username)

Check to see ifusername is a collaborator on this repository.

Parameters:: username (str orUser) – (required), login for the user
Returns:: True if successful, False otherwise
Return type:: bool

issue(number)

Get the issue specified bynumber.

Parameters:: number (int) – (required), number of the issue on this repository
Returns:: the issue
Return type:: Issue

issue_events(number=-1,etag=None)

Iterate over issue events on this repository.

Parameters:

number (int) – (optional), number of events to return. Default: -1returns all available events
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of events on issues

Return type:

IssueEvent

issues(milestone=None,state=None,assignee=None,mentioned=None,labels=None,sort=None,direction=None,since=None,number=-1,etag=None)

Iterate over issues on this repo based upon parameters passed.

Changed in version 0.9.0:Thestate parameter now accepts ‘all’ in addition to ‘open’and ‘closed’.

Parameters:

milestone (int) – (optional), ‘none’, or ‘*’
state (str) – (optional), accepted values: (‘all’, ‘open’, ‘closed’)
assignee (str) – (optional), ‘none’, ‘*’, or login name
mentioned (str) – (optional), user’s login name
labels (str) – (optional), comma-separated list of labels, e.g. ‘bug,ui,@high’
sort – (optional), accepted values:(‘created’, ‘updated’, ‘comments’, ‘created’)
direction (str) – (optional), accepted values: (‘asc’, ‘desc’)
since (datetime or str) – (optional), Only issues after this date willbe returned. This can be adatetime or anISO8601 formatteddate string, e.g., 2012-05-20T23:10:27Z
number (int) – (optional), Number of issues to return.By default all issues are returned
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of issues

Return type:

ShortIssue

key(id_num)

Get the specified deploy key.

Parameters:: id_num (int) – (required), id of the key
Returns:: the deploy key
Return type:: Key

keys(number=-1,etag=None)

Iterate over deploy keys on this repository.

Parameters:

number (int) – (optional), number of keys to return. Default: -1returns all available keys
etag (str) – (optional), ETag from a previous request to the sameendpoint

Returns:

generator of keys

Return type:

label(name)

Get the label specified byname.

Parameters:: name (str) – (required), name of the label
Returns:: the label
Return type:: Label

labels(number=-1,etag=None)

Iterate over labels on this repository.

Parameters:

number (int) – (optional), number of labels to return. Default: -1returns all available labels
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of labels

Return type:

languages(number=-1,etag=None)

Iterate over the programming languages used in the repository.

Parameters:

number (int) – (optional), number of languages to return. Default:-1 returns all used languages
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of tuples

Return type:

tuple

latest_pages_build()

Get the build information for the most recent Pages build.

Returns:: the information for the most recent build
Return type:: PagesBuild

latest_release()

Get the latest release.

Draft releases and prereleases are not returned by this endpoint.

Returns:: the release
Return type:: Release

license()

Get the contents of a license for the repo.

Returns:: the license
Return type:: RepositoryLicense

mark_notifications(last_read='')

Mark all notifications in this repository as read.

Parameters:: last_read (str) – (optional), Describes the last point thatnotifications were checked. Anything updated since this time willnot be updated. Default: Now. Expected in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZ. Example: “2012-10-09T23:39:01Z”.
Returns:: True if successful, False otherwise
Return type:: bool

merge(base,head,message='')

Perform a merge fromhead intobase.

Parameters:

base (str) – (required), where you’re merging into
head (str) – (required), where you’re merging from
message (str) – (optional), message to be used for the commit

Returns:

the commit resulting from the merge

Return type:

milestone(number)

Get the milestone indicated bynumber.

Parameters:: number (int) – (required), unique id number of the milestone
Returns:: the milestone
Return type:: Milestone

milestones(state=None,sort=None,direction=None,number=-1,etag=None)

Iterate over the milestones on this repository.

Parameters:

state (str) – (optional), state of the milestones, acceptedvalues: (‘open’, ‘closed’)
sort (str) – (optional), how to sort the milestones, acceptedvalues: (‘due_date’, ‘completeness’)
direction (str) – (optional), direction to sort the milestones,accepted values: (‘asc’, ‘desc’)
number (int) – (optional), number of milestones to return.Default: -1 returns all milestones
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of milestones

Return type:

network_events(number=-1,etag=None)

Iterate over events on a network of repositories.

Parameters:

number (int) – (optional), number of events to return. Default: -1returns all available events
etag (str) – (optional), ETag from a previous request to the sameendpoint

Returns:

generator of events

Return type:

new_session()

Generate a new session.

Returns:: A brand new session
Return type:: GitHubSession

notifications(all=False,participating=False,since=None,number=-1,etag=None)

Iterate over the notifications for this repository.

Parameters:

all (bool) – (optional), show all notifications, including onesmarked as read
participating (bool) – (optional), show only the notifications theuser is participating in directly
since (datetime or str) – (optional), filters out any notifications updatedbefore the given time. This can be adatetime or anISO8601formatted date string, e.g., 2012-05-20T23:10:27Z
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of notification threads

Return type:

Thread

pages()

Get information about this repository’s pages site.

Returns:: information about this repository’s GitHub pages site
Return type:: PagesInfo

pages_builds(number=-1,etag=None)

Iterate over pages builds of this repository.

Parameters:

number (int) – (optional) the number of builds to return
etag (str) – (optional), ETag value from a previous request

Returns:

generator of builds

Return type:

PagesBuild

project(id,etag=None)

Return the organization project with the given ID.

Parameters:: id (int) – (required), ID number of the project
Returns:: the project
Return type:: Project

projects(number=-1,etag=None)

Iterate over projects for this organization.

Parameters:

number (int) – (optional), number of members to return. Default:-1 will return all available.
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of projects

Return type:

pull_request(number)

Get the pull request indicated bynumber.

Parameters:: number (int) – (required), number of the pull request.
Returns:: the pull request
Return type:: PullRequest

pull_requests(state=None,head=None,base=None,sort='created',direction='desc',number=-1,etag=None)

List pull requests on repository.

Changed in version 0.9.0:

Thestate parameter now accepts ‘all’ in addition to ‘open’and ‘closed’.
Thesort parameter was added.
Thedirection parameter was added.

Parameters:

state (str) – (optional), accepted values: (‘all’, ‘open’, ‘closed’)
head (str) – (optional), filters pulls by head user and branchname in the formatuser:ref-name, e.g.,seveas:debian
base (str) – (optional), filter pulls by base branch name.Example:develop.
sort (str) – (optional), Sort pull requests bycreated,updated,popularity,long-running. Default: ‘created’
direction (str) – (optional), Choose the direction to list pullrequests. Accepted values: (‘desc’, ‘asc’). Default: ‘desc’
number (int) – (optional), number of pulls to return. Default: -1returns all available pull requests
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of pull requests

Return type:

propertyratelimit_remaining

Number of requests before GitHub imposes a ratelimit.

Returns:: int

readme()

Get the README for this repository.

Returns:: this repository’s readme
Return type:: Contents

ref(ref)

Get a reference pointed to byref.

The most common will be branches and tags. For a branch, you mustspecify ‘heads/branchname’ and for a tag, ‘tags/tagname’. Essentially,the system should return any reference you provide it in the namespace,including notes and stashes (provided they exist on the server).

Parameters:: ref (str) – (required)
Returns:: the reference
Return type:: Reference

refresh(conditional:bool=False)→GitHubCore

Re-retrieve the information for this object.

The reasoning for the return value is the following example:

repos=[r.refresh()forring.repositories_by('kennethreitz')]

Without the return value, that would be an array ofNone’s and youwould otherwise have to do:

repos=[rforiing.repositories_by('kennethreitz')][r.refresh()forrinrepos]

Which is really an anti-pattern.

Changed in version 0.5.

Parameters:: conditional (bool) – If True, then we will search for a storedheader (‘Last-Modified’, or ‘ETag’) on the object and send thatas described in theConditional Requests section of the docs
Returns:: self

refs(subspace='',number=-1,etag=None)

Iterate over references for this repository.

Parameters:

subspace (str) – (optional), e.g. ‘tags’, ‘stashes’, ‘notes’
number (int) – (optional), number of refs to return. Default: -1returns all available refs
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of references

Return type:

release(id)

Get a single release.

Parameters:: id (int) – (required), id of release
Returns:: the release
Return type:: Release

release_from_tag(tag_name)

Get a release by tag name.

release_from_tag() returns a release with specified tagwhile release() returns a release with specified release id

Parameters:: tag_name (str) – (required) name of tag
Returns:: the release
Return type:: Release

releases(number=-1,etag=None)

Iterate over releases for this repository.

Parameters:

number (int) – (optional), number of refs to return. Default: -1returns all available refs
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of releases

Return type:

remove_collaborator(username)

Remove collaboratorusername from the repository.

Parameters:: username (str orUser) – (required), login name of the collaborator
Returns:: True if successful, False otherwise
Return type:: bool

replace_topics(new_topics)

Replace the repository topics withnew_topics.

Parameters:: topics (list) – (required), new topics of the repository
Returns:: new topics of the repository
Return type:: Topics

stargazers(number=-1,etag=None)

List users who have starred this repository.

Parameters:

number (int) – (optional), number of stargazers to return.Default: -1 returns all subscribers available
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of users

Return type:

Stargazer

statuses(sha,number=-1,etag=None)

Iterate over the statuses for a specific SHA.

Warning

Deprecated in v1.0. Also deprecated upstreamhttps://developer.github.com/v3/repos/statuses/

Parameters:

sha (str) – SHA of the commit to list the statuses of
number (int) – (optional), return up to number statuses. Default:-1 returns all available statuses.
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of statuses

Return type:

subscribe()

Subscribe the user to this repository’s notifications.

New in version 1.0.

This replacesRepository#set_subscription

Returns:: the new repository subscription
Return type:: RepositorySubscription

subscribers(number=-1,etag=None)

Iterate over users subscribed to this repository.

Parameters:

number (int) – (optional), number of subscribers to return.Default: -1 returns all subscribers available
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of users subscribed to this repository

Return type:

http://learn.github.com/p/tagging.html

subscription()

Return subscription for this Repository.

Returns:: the user’s subscription to this repository
Return type:: RepositorySubscription

tag(sha)

Get an annotated tag.

Parameters:: sha (str) – (required), sha of the object for this tag
Returns:: the annotated tag
Return type:: Tag

tags(number=-1,etag=None)

Iterate over tags on this repository.

Parameters:

number (int) – (optional), return up to at most number tags.Default: -1 returns all available tags.
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of tags with GitHub repository specific information

Return type:

RepoTag

teams(number=-1,etag=None)

Iterate over teams with access to this repository.

Parameters:

number (int) – (optional), return up to number Teams. Default: -1returns all Teams.
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of teams

Return type:

Team

topics()

Get the topics of this repository.

Returns:: this repository’s topics
Return type:: Topics

tree(sha,recursive=False)

Get a tree.

Parameters:

sha (str) – (required), sha of the object for this tree
recursive (bool) – (optional), whether to fetch the tree recursively

Returns:

the tree

Return type:

See:http://developer.github.com/v3/repos/contents/#get-archive-link

unignore()

Unignore notifications from this repository for the user.

New in version 1.3.

This replacesRepository#set_subscription.

Returns:: the new repository subscription
Return type:: :class:~github3.notifications.RepositorySubscription`

unsubscribe()

Unsubscribe the user to this repository’s notifications.

New in version 1.3.

This replacesRepository#set_subscription

Returns:: the new repository subscription
Return type:: RepositorySubscription

views(per='day')

Get the total number of repository views and breakdown per day orweek for the last 14 days.

New in version 1.4.0.

Parameters:: per (str) – (optional), (‘day’, ‘week’), views reporting period. Default ‘day’will return views per day for the last 14 days.
Returns:: views data
Return type:: ViewsStats
Raises:: ValueError if per is not a valid choice

weekly_commit_count()

Retrieve the total commit counts.

Note

All statistics methods may return a 202. If github3.pyreceives a 202 in this case, it will return an emtpy dictionary.You should give the API a moment to compose the data and then re-request it via this method.

..versionadded:: 0.7

The dictionary returned has two entries:all andowner. Eachhas a fifty-two element long list of commit counts. (Note:allincludes the owner.)d['all'][0] will be the oldest week,d['all'][51] will be the most recent.

Returns:: the commit count as a dictionary
Return type:: dict

classgithub3.repos.repo.ShortRepository(json,session:GitHubSession)

This represents a Repository object returned in collections.

GitHub’s API returns different amounts of information about repositoriesbased upon how that information is retrieved. This object exists torepresent the full amount of information returned for a specificrepository. For example, you would receive this class when callingrepository(). To provide a clear distinctionbetween the types of repositories, github3.py uses different classes withdifferent sets of attributes.

This object only has the following attributes:

url: The GitHub API URL for this repository, e.g.,https://api.github.com/repos/sigmavirus24/github3.py.

archive_urlt: TheURITemplate object representing theURI template returned by GitHub’s API. Checkarchive_urlt.variables for the list of variables that canbe passed toarchive_urlt.expand().

assignees_urlt: TheURITemplate object representing theURI template returned by GitHub’s API. Checkassignees_urlt.variables for the list of variables that canbe passed toassignees_urlt.expand().

blobs_urlt: TheURITemplate object representing theURI template returned by GitHub’s API. Checkblobs_urlt.variables for the list of variables that canbe passed toblobs_urlt.expand().

branches_urlt: TheURITemplate object representing theURI template returned by GitHub’s API. Checkbranches_urlt.variables for the list of variables that canbe passed tobranches_urlt.expand().

collaborators_urlt: TheURITemplate object representing theURI template returned by GitHub’s API. Checkcollaborators_urlt.variables for the list of variables that canbe passed tocollaborators_urlt.expand().

comments_urlt: TheURITemplate object representing theURI template returned by GitHub’s API. Checkcomments_urlt.variables for the list of variables that canbe passed tocomments_urlt.expand().

commits_urlt: TheURITemplate object representing theURI template returned by GitHub’s API. Checkcommits_urlt.variables for the list of variables that canbe passed tocommits_urlt.expand().

compare_urlt: TheURITemplate object representing theURI template returned by GitHub’s API. Checkcompare_urlt.variables for the list of variables that canbe passed tocompare_urlt.expand().

contents_urlt: TheURITemplate object representing theURI template returned by GitHub’s API. Checkcontents_urlt.variables for the list of variables that canbe passed tocontents_urlt.expand().

contributors_url: The URL to retrieve this repository’s list of contributors.

deployments_url: The URL to retrieve this repository’s list of deployments.

description: The administrator created description of the repository.

downloads_url: The URL to retrieve this repository’s list of downloads.

events_url: The URL to retrieve this repository’s list of events.

fork: Whether or not this repository is a fork of another.

forks_url: The URL to retrieve this repository’s list of forks.

full_name: The full name of this repository, e.g.,sigmavirus24/github3.py.

git_commits_urlt: TheURITemplate object representing theURI template returned by GitHub’s API. Checkgit_commits_urlt.variables for the list of variables that canbe passed togit_commits_urlt.expand().

git_refs_urlt: TheURITemplate object representing theURI template returned by GitHub’s API. Checkgit_refs_urlt.variables for the list of variables that canbe passed togit_refs_urlt.expand().

git_tags_urlt: TheURITemplate object representing theURI template returned by GitHub’s API. Checkgit_tags_urlt.variables for the list of variables that canbe passed togit_tags_urlt.expand().

hooks_url: The URL to retrieve this repository’s list of hooks.

html_url: The HTML URL of this repository, e.g.,https://github.com/sigmavirus24/github3.py.

id: The unique GitHub assigned numerical id of this repository.

issue_comment_urlt: TheURITemplate object representing theURI template returned by GitHub’s API. Checkissue_comment_urlt.variables for the list of variables that canbe passed toissue_comment_urlt.expand().

issue_events_urlt: TheURITemplate object representing theURI template returned by GitHub’s API. Checkissue_events_urlt.variables for the list of variables that canbe passed toissue_events_urlt.expand().

issues_urlt: TheURITemplate object representing theURI template returned by GitHub’s API. Checkissues_urlt.variables for the list of variables that canbe passed toissues_urlt.expand().

keys_urlt: TheURITemplate object representing theURI template returned by GitHub’s API. Checkkeys_urlt.variables for the list of variables that canbe passed tokeys_urlt.expand().

labels_urlt: TheURITemplate object representing theURI template returned by GitHub’s API. Checklabels_urlt.variables for the list of variables that canbe passed tolabels_urlt.expand().

languages_url: The URL to retrieve this repository’s list of languages.

merges_url: The URL to retrieve this repository’s list of merges.

milestones_urlt: TheURITemplate object representing theURI template returned by GitHub’s API. Checkmilestones_urlt.variables for the list of variables that canbe passed tomilestones_urlt.expand().

name: The name of the repository, e.g.,github3.py.

notifications_urlt: TheURITemplate object representing theURI template returned by GitHub’s API. Checknotifications_urlt.variables for the list of variables that canbe passed tonotifications_urlt.expand().

owner: AShortUser object representing the owner ofthe repository.

private: Whether the repository is private or public.

pulls_urlt: TheURITemplate object representing theURI template returned by GitHub’s API. Checkpulls_urlt.variables for the list of variables that canbe passed topulls_urlt.expand().

releases_urlt: TheURITemplate object representing theURI template returned by GitHub’s API. Checkreleases_urlt.variables for the list of variables that canbe passed toreleases_urlt.expand().

stargazers_url: The URL to retrieve this repository’s list of stargazers.

statuses_urlt: TheURITemplate object representing theURI template returned by GitHub’s API. Checkstatuses_urlt.variables for the list of variables that canbe passed tostatuses_urlt.expand().

subscribers_url: The URL to retrieve this repository’s list of subscribers.

subscription_url: The URL to modify subscription to this repository.

tags_url: The URL to retrieve this repository’s list of tags.

teams_url: The URL to retrieve this repository’s list of teams.

trees_urlt: TheURITemplate object representing theURI template returned by GitHub’s API. Checktrees_urlt.variables for the list of variables that canbe passed totrees_urlt.expand().

New in version 1.0.0.

add_collaborator(username,permission=None)

Addusername as a collaborator to a repository.

Parameters:

username (str orUser) – (required), username of the user
permission (str) – (optional), permission to grant the collaborator, valid onorganization repositories only.Can be ‘pull’, ‘triage’, ‘push’, ‘maintain’, ‘admin’ or anorganization-defined custom role name.

Returns:

True if successful, False otherwise

Return type:

archive(format,path='',ref='master')

Get the tarball or zipball archive for this repo at ref.

Parameters:

format (str) – (required), accepted values: (‘tarball’, ‘zipball’)
path (str,file) – (optional), path where the file should be savedto, default is the filename provided in the headers and will bewritten in the current directory.it can take a file-like object as well
ref (str) – (optional)

Returns:

True if successful, False otherwise

Return type:

bool

as_dict()

Return the attributes for this object as a dictionary.

This is equivalent to calling:

json.loads(obj.as_json())

Returns:: this object’s attributes serialized to a dictionary
Return type:: dict

as_json()

Return the json data for this object.

This is equivalent to calling:

json.dumps(obj.as_dict())

Returns:: this object’s attributes as a JSON string
Return type:: str

asset(id)

Return a single asset.

Parameters:: id (int) – (required), id of the asset
Returns:: the asset
Return type:: Asset

assignees(number=-1,etag=None)

Iterate over all assignees to which an issue may be assigned.

Parameters:

number (int) – (optional), number of assignees to return. Default:-1 returns all available assignees
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of users

Return type:

auto_trigger_checks(app_id,enabled=True)

Change preferences for automatic creation of check suites.

New in version 1.3.0.

Parameters:

app_id (int) – (required), the id of the GitHub App
enabled (bool) – (optional), enable automatic creation of check suitesDefault: True

Returns:

the check suite settings for this repository

Return type:

dict

blob(sha)

Get the blob indicated bysha.

Parameters:: sha (str) – (required), sha of the blob
Returns:: the git blob
Return type:: Blob

branch(name)

Get the branchname of this repository.

Parameters:: name (str) – (required), branch name
Returns:: the branch
Return type:: Branch

branches(number=-1,protected=False,etag=None)

Iterate over the branches in this repository.

Parameters:

number (int) – (optional), number of branches to return. Default: -1 returns allbranches
protected (bool) – (optional), True lists only protected branches.Default: False
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of branches

Return type:

Branch

check_run(id)

Return a single check run.

New in version 1.3.0.

Parameters:: id (int) – (required), id of the check run
Returns:: the check run
Return type:: CheckRun

check_suite(id)

Return a single check suite.

New in version 1.3.0.

Parameters:: id (int) – (required), id of the check suite
Returns:: the check suite
Return type:: CheckSuite

clones(per='day')

Get the total number of repository clones and breakdown per day orweek for the last 14 days.

New in version 1.4.0.

Parameters:: per (str) – (optional), (‘day’, ‘week’), clones reporting period. Default ‘day’will return clones per day for the last 14 days.
Returns:: clones data
Return type:: ClonesStats
Raises:: ValueError if per is not a valid choice

code_frequency(number=-1,etag=None)

Iterate over the code frequency per week.

New in version 0.7.

Returns a weekly aggregate of the number of additions and deletionspushed to this repository.

Note

Parameters:

number (int) – (optional), number of weeks to return. Default: -1returns all weeks
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of lists[seconds_from_epoch,additions,deletions]

Return type:

list

collaborators(affiliation='all',number=-1,etag=None)

Iterate over the collaborators of this repository.

Parameters:

affiliation (str) – (optional), affiliation of the collaborator to the repository.Default: “all” returns contributors with all affiliations
number (int) – (optional), number of collaborators to return.Default: -1 returns all comments
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of collaborators

Return type:

Collaborator

comments(number=-1,etag=None)

Iterate over comments on all commits in the repository.

Parameters:

number (int) – (optional), number of comments to return. Default:-1 returns all comments
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of comments on commits

Return type:

See:http://developer.github.com/v3/repos/statistics/

commit(sha)

Get a single (repo) commit.

Seegit_commit() for the Git Data Commit.

Parameters:: sha (str) – (required), sha of the commit
Returns:: the commit
Return type:: RepoCommit

commit_activity(number=-1,etag=None)

Iterate over last year of commit activity by week.

New in version 0.7.

Note

Parameters:

number (int) – (optional), number of weeks to return. Default -1will return all of the weeks.
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of dictionaries

Return type:

dict

commit_comment(comment_id)

Get a single commit comment.

Parameters:: comment_id (int) – (required), id of the comment used by GitHub
Returns:: the comment on the commit
Return type:: RepoComment

commits(sha=None,path=None,author=None,number=-1,etag=None,since=None,until=None,per_page=None)

Iterate over commits in this repository.

Parameters:

sha (str) – (optional), sha or branch to start listing commits from
path (str) – (optional), commits containing this path will be listed
author (str) – (optional), GitHub login, real name, or email tofilter commits by (using commit author)
number (int) – (optional), number of commits to return. Default:-1 returns all commits
etag (str) – (optional), ETag from a previous request to the same endpoint
since (datetime or str) – (optional), Only commits after this date will be returned.This can be adatetime or anISO8601 formatteddate string.
until (datetime or str) – (optional), Only commits before this date willbe returned. This can be adatetime or anISO8601 formatteddate string.
per_page (int) – (optional), commits listing page size

Returns:

generator of commits

Return type:

compare_commits(base,head)

Compare two commits.

Parameters:

base (str) – (required), base for the comparison
head (str) – (required), compare this against base

Returns:

the comparison of the commits

Return type:

Comparison

contributor_statistics(number=-1,etag=None)

Iterate over the contributors list.

New in version 0.7.

Note

Parameters:

number (int) – (optional), number of weeks to return. Default -1will return all of the weeks.
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of contributor statistics for each contributor

Return type:

ContributorStats

contributors(anon=False,number=-1,etag=None)

Iterate over the contributors to this repository.

Parameters:

anon (bool) – (optional), True lists anonymous contributors as well
number (int) – (optional), number of contributors to return.Default: -1 returns all contributors
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of contributor users

Return type:

Contributor

create_blob(content,encoding)

Create a blob withcontent.

Parameters:

content (str) – (required), content of the blob
encoding (str) – (required), (‘base64’, ‘utf-8’)

Returns:

string of the SHA returned

Returns:

str

create_branch_ref(name,sha=None)

Create a branch git reference.

This is a shortcut for callinggithub3.repos.repo.Repository.create_ref().

Parameters:

branch (str) – (required), the branch to create
sha (str) – the commit to base the branch from

Returns:

a reference object representing the branch

Return type:

create_check_run(name,head_sha,details_url=None,external_id=None,started_at=None,status=None,conclusion=None,completed_at=None,output=None,actions=None)

Create a check run object on a commit

New in version 1.3.0.

Parameters:

name (str) – (required), The name of the check
head_sha (str) – (required), The SHA of the commit
details_url (str) – (optional), The URL of the integrator’s site that has the fulldetails of the check
external_id (str) – (optional), A reference for the run on the integrator’s system
started_at (str) – (optional), ISO 8601 time format: YYYY-MM-DDTHH:MM:SSZ
status (str) – (optional), (‘queued’, ‘in_progress’, ‘completed’)
conclusion (str) – (optional), Required if you provide ‘completed_at’, or a‘status’ of ‘completed’. The final conclusion of the check.(‘success’, ‘failure’, ‘neutral’, ‘cancelled’, ‘timed_out’,‘action_required’)
completed_at (str) – (optional), Required if you provide ‘conclusion’. ISO 8601 timeformat: YYYY-MM-DDTHH:MM:SSZ
output (dict) – (optional), key-value pairs representing the output. Format:{'title':'string','summary':'text,canbemarkdown','text':'text,canbemarkdown','annotations':[{}],'images':[{}]}
actions (list) – (optional), list of action objects. Format is:[{'label':'text','description','text','identifier','text'},...]

Returns:

the created check run

Return type:

CheckRun

create_check_suite(head_sha)

Create a check suite object on a commit

New in version 1.3.0.

Parameters:: head_sha (str) – The sha of the head commit.
Returns:: the created check suite
Return type:: CheckSuite

create_comment(body,sha,path=None,position=None,line=1)

Create a comment on a commit.

Parameters:

body (str) – (required), body of the message
sha (str) – (required), commit id
path (str) – (optional), relative path of the file to comment on
position (str) – (optional), line index in the diff to comment on
line (int) – (optional), line number of the file to comment on, default: 1

Returns:

the created comment

Return type:

create_commit(message,tree,parents,author=None,committer=None)

Create a commit on this repository.

Parameters:

message (str) – (required), commit message
tree (str) – (required), SHA of the tree object this commit points to
parents (list) – (required), SHAs of the commits that were parentsof this commit. If empty, the commit will be written as the rootcommit. Even if there is only one parent, this should be anarray.
author (dict) – (optional), if omitted, GitHub willuse the authenticated user’s credentials and the currenttime. Format: {‘name’: ‘Committer Name’, ‘email’:‘name@example.com’, ‘date’: ‘YYYY-MM-DDTHH:MM:SS+HH:00’}
committer (dict) – (optional), if ommitted, GitHub will use theauthor parameters. Should be the same format as the authorparameter.

Returns:

the created commit

Return type:

Commit

create_deployment(ref,required_contexts=None,payload='',auto_merge=False,description='',environment=None)

Create a deployment.

Parameters:

ref (str) – (required), The ref to deploy. This can be a branch, tag, or sha.
required_contexts (list) – Optional array of status contextsverified against commit status checks. To bypass checkingentirely pass an empty array. Default: []
payload (str) – Optional JSON payload with extra information aboutthe deployment. Default: “”
auto_merge (bool) – Optional parameter to merge the default branchinto the requested deployment branch if necessary. Default: False
description (str) – Optional short description. Default: “”
environment (str) – Optional name for the target deploymentenvironment (e.g., production, staging, qa). Default: “production”

Returns:

the created deployment

Return type:

create_file(path,message,content,branch=None,committer=None,author=None)

Create a file in this repository.

Parameters:

path (str) – (required), path of the file in the repository
message (str) – (required), commit message
content (bytes) – (required), the actual data in the file
branch (str) – (optional), branch to create the commit on.Defaults to the default branch of the repository
committer (dict) – (optional), if no information is given theauthenticated user’s information will be used. You must specifyboth a name and email.
author (dict) – (optional), if omitted this will be filled in withcommitter information. If passed, you must specify both a name andemail.

Returns:

dictionary of contents and commit for created file

Return type:

Contents,Commit

create_fork(organization=None)

Create a fork of this repository.

Parameters:: organization (str) – (required), login for organization to create the fork under
Returns:: the fork of this repository
Return type:: Repository

create_hook(name,config,events=['push'],active=True)

Create a hook on this repository.

Parameters:

name (str) – (required), name of the hook
config (dict) – (required), key-value pairs which act as settings for this hook
events (list) – (optional), events the hook is triggered for
active (bool) – (optional), whether the hook is actually triggered

Returns:

the created hook

Return type:

create_issue(title,body=None,assignee=None,milestone=None,labels=None,assignees=None)

Create an issue on this repository.

Parameters:

title (str) – (required), title of the issue
body (str) – (optional), body of the issue
assignee (str) – (optional), login of the user to assign the issue to
milestone (int) – (optional), id number of the milestone toattribute this issue to (e.g.m is aMilestone object,m.numberis what you pass here.)
labels ([str]) – (optional), labels to apply to this issue
assignees ([str]) – (optional), login of the users to assign the issue to

Returns:

the created issue

Return type:

ShortIssue

create_key(title,key,read_only=False)

Create a deploy key.

Parameters:

title (str) – (required), title of key
key (str) – (required), key text
read_only (bool) – (optional), restrict key access to read-only, default is False

Returns:

the created key

Return type:

create_label(name,color,description=None)

Create a label for this repository.

Parameters:

name (str) – (required), name to give to the label
color (str) – (required), value of the color to assign to thelabel, e.g., ‘#fafafa’ or ‘fafafa’ (the latter is what is sent)
description (str) – (optional), description to give to the label

Returns:

the created label

Return type:

create_milestone(title,state=None,description=None,due_on=None)

Create a milestone for this repository.

Parameters:

title (str) – (required), title of the milestone
state (str) – (optional), state of the milestone, acceptedvalues: (‘open’, ‘closed’), default: ‘open’
description (str) – (optional), description of the milestone
due_on (str) – (optional), ISO 8601 formatted due date

Returns:

the created milestone

Return type:

create_project(name,body=None)

Create a project for this repository.

Parameters:

name (str) – (required), name of the project
body (str) – (optional), body of the project

Returns:

the created project

Return type:

create_pull(title,base,head,body=None,maintainer_can_modify=None)

Create a pull request ofhead ontobase branch in this repo.

Parameters:

title (str) – (required)
base (str) – (required), e.g., ‘master’
head (str) – (required), e.g., ‘username:branch’
body (str) – (optional), markdown formatted description
maintainer_can_modify (bool) – (optional), Indicates whether a maintainer is allowed to modify thepull request or not.

Returns:

the created pull request

Return type:

create_pull_from_issue(issue,base,head)

Create a pull request from issue #``issue``.

Parameters:

issue (int) – (required), issue number
base (str) – (required), e.g., ‘master’
head (str) – (required), e.g., ‘username:branch’

Returns:

the created pull request

Return type:

create_ref(ref,sha)

Create a reference in this repository.

Parameters:

ref (str) – (required), fully qualified name of the reference,e.g.refs/heads/master. If it doesn’t start withrefs andcontain at least two slashes, GitHub’s API will reject it.
sha (str) – (required), SHA1 value to set the reference to

Returns:

the created ref

Return type:

create_release(tag_name,target_commitish=None,name=None,body=None,draft=False,prerelease=False)

Create a release for this repository.

Parameters:

tag_name (str) – (required), name to give to the tag
target_commitish (str) – (optional), vague concept of a target, either a SHA or a branchname.
name (str) – (optional), name of the release
body (str) – (optional), description of the release
draft (bool) – (optional), whether this release is a draft or not
prerelease (bool) – (optional), whether this is a prerelease or not

Returns:

the created release

Return type:

create_status(sha,state,target_url=None,description=None,context='default')

Create a status object on a commit.

Parameters:

sha (str) – (required), SHA of the commit to create the status on
state (str) – (required), state of the test; only the followingare accepted: ‘pending’, ‘success’, ‘error’, ‘failure’
target_url (str) – (optional), URL to associate with this status.
description (str) – (optional), short description of the status
context (str) – (optional), A string label to differentiate thisstatus from the status of other systems

Returns:

the created status

Return type:

create_tag(tag,message,sha,obj_type,tagger,lightweight=False)

Create a tag in this repository.

By default, this method creates an annotated tag. If you wish tocreate a lightweight tag instead, passlightweight=True.

If you are creating an annotated tag, this method makes2 calls tothe API:

Creates the tag object
Creates the reference for the tag

This behaviour is required by the GitHub API.

Parameters:

tag (str) – (required), name of the tag
message (str) – (required), tag message
sha (str) – (required), SHA of the git object this is tagging
obj_type (str) – (required), type of object being tagged, e.g., ‘commit’, ‘tree’,‘blob’
tagger (dict) – (required), containing the name, email of thetagger and optionally the date it was tagged
lightweight (bool) – (optional), if False, create an annotatedtag, otherwise create a lightweight tag (a Reference).

Returns:

if creating a lightweight tag, this will return aReference, otherwise it will return aTag

Return type:

Tag orReference

create_tree(tree,base_tree=None)

Create a tree on this repository.

Parameters:

tree (list) – (required), specifies the tree structure.Format: [{‘path’: ‘path/file’, ‘mode’:‘filemode’, ‘type’: ‘blob or tree’, ‘sha’: ‘44bfc6d…’}]
base_tree (str) – (optional), SHA1 of the tree you want to update with new data

Returns:

the created tree

Return type:

delete()

Delete this repository.

Returns:: True if successful, False otherwise
Return type:: bool

delete_key(key_id)

Delete the key with the specified id from your deploy keys list.

Returns:: True if successful, False otherwise
Return type:: bool

delete_subscription()

Delete the user’s subscription to this repository.

Returns:: True if successful, False otherwise
Return type:: bool

deployment(id)

Retrieve the deployment identified byid.

Parameters:: id (int) – (required), id for deployments.
Returns:: the deployment
Return type:: Deployment

deployments(number=-1,etag=None)

Iterate over deployments for this repository.

Parameters:

number (int) – (optional), number of deployments to return.Default: -1, returns all available deployments
etag (str) – (optional), ETag from a previous request for all deployments

Returns:

generator of deployments

Return type:

directory_contents(directory_path,ref=None,return_as=<class'list'>)

Get the contents of each file indirectory_path.

If the path provided is actually a directory, you will receive alist back of the form:

[('filename.md',Contents(...)),('github.py',Contents(...)),# ...('fiz.py',Contents(...))]

You can either then transform it into a dictionary:

contents=dict(repo.directory_contents('path/to/dir/'))

Or you can use thereturn_as parameter to have it return adictionary for you:

contents=repo.directory_contents('path/to/dir/',return_as=dict)

Parameters:

path (str) – (required), path to file, e.g. github3/repos/repo.py
ref (str) – (optional), the string name of a commit/branch/tag.Default: master
return_as – (optional), how to return the directory’s contents.Default:list

Returns:

list of tuples of the filename and the Contents returned

Return type:

[(str,Contents)]

Raises:

github3.exceptions.UnprocessableResponseBody – When the requested directory is not actually a directory

Edit this repository.

Parameters:

name (str) – (required), name of the repository
description (str) – (optional), If notNone, change thedescription for this repository. API default:None - leavevalue unchanged.
homepage (str) – (optional), If notNone, change the homepagefor this repository. API default:None - leave value unchanged.
private (bool) – (optional), IfTrue, make the repositoryprivate. IfFalse, make the repository public. API default:None - leave value unchanged.
has_issues (bool) – (optional), IfTrue, enable issues forthis repository. IfFalse, disable issues for this repository.API default:None - leave value unchanged.
has_wiki (bool) – (optional), IfTrue, enable the wiki forthis repository. IfFalse, disable the wiki for thisrepository. API default:None - leave value unchanged.
has_downloads (bool) – (optional), IfTrue, enable downloadsfor this repository. IfFalse, disable downloads for thisrepository. API default:None - leave value unchanged.
default_branch (str) – (optional), If notNone, change thedefault branch for this repository. API default:None - leavevalue unchanged.
archived (bool) – (optional), If notNone, toggle the archivedattribute on the repository to control whether it is archived ornot.
allow_rebase_merge (bool) – (optional), If notNone, change whether the merge strategythat allows adding all commits from the head branch onto the basebranch individually is enabled for this repository. API default:None - leave value unchanged.
allow_squash_merge (bool) – (optional), If notNone, change whether combining all commitsfrom the head branch into a single commit in the base branch isallowed. API default:None - leave value unchanged.
allow_merge_commit (bool) – (optional), If notNone, change whether adding all commitsfrom the head branch to the base branch with a merge commit isallowed. API default:None - leave value unchanged.
has_projects (bool) – (optional), IfTrue, enable projects for this repository.IfFalse, disable projects projects for this repository.API default:None - leave value unchanged.

Returns:

True if successful, False otherwise

Return type:

bool

events(number=-1,etag=None)

Iterate over events on this repository.

Parameters:

number (int) – (optional), number of events to return. Default: -1returns all available events
etag (str) – (optional), ETag from a previous request to the sameendpoint

Returns:

generator of events

Return type:

file_contents(path,ref=None)

Get the contents of the file pointed to bypath.

Parameters:

path (str) – (required), path to file, e.g. github3/repos/repo.py
ref (str) – (optional), the string name of a commit/branch/tag.Default: master

Returns:

the contents of the file requested

Return type:

Contents

forks(sort='',number=-1,etag=None)

Iterate over forks of this repository.

Parameters:

sort (str) – (optional), accepted values:(‘newest’, ‘oldest’, ‘stargazers’), API default: ‘newest’
number (int) – (optional), number of forks to return. Default: -1returns all forks
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of forks of this repository

Return type:

ShortRepository

classmethodfrom_dict(json_dict,session): Return an instance of this class formed fromjson_dict.

classmethodfrom_json(json,session): Return an instance of this class formed fromjson.

git_commit(sha)

Get a single (git) commit.

Parameters:: sha (str) – (required), sha of the commit
Returns:: the single commit data from git
Return type:: Commit

hook(hook_id)

Get a single hook.

Parameters:: hook_id (int) – (required), id of the hook
Returns:: the hook
Return type:: Hook

hooks(number=-1,etag=None)

Iterate over hooks registered on this repository.

Parameters:

number (int) – (optional), number of hoks to return. Default: -1returns all hooks
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of hooks

Return type:

ignore()

Ignore notifications from this repository for the user.

New in version 1.0.

This replacesRepository#set_subscription.

Returns:: the new repository subscription
Return type:: :class:~github3.notifications.RepositorySubscription`

import_issue(title,body,created_at,assignee=None,milestone=None,closed=None,labels=None,comments=None)

Import an issue into the repository.

Parameters:

title (string) – (required) Title of issue
body (string) – (required) Body of issue
created_at (datetime or str) – (required) Creation timestamp
assignee (string) – (optional) Username to assign issue to
milestone (int) – (optional) Milestone ID
closed (boolean) – (optional) Status of issue is Closed if True
labels (list) – (optional) List of labels containing string names
comments (list) – (optional) List of dictionaries which containcreated_at and body attributes

Returns:

the imported issue

Return type:

imported_issue(imported_issue_id)

Retrieve imported issue specified by imported issue id.

Parameters:: imported_issue_id (int) – (required) id of imported issue
Returns:: the imported issue
Return type:: ImportedIssue

imported_issues(number=-1,since=None,etag=None)

Retrieve the collection of imported issues via the API.

Parameters:

number (int) – (optional), number of imported issues to return.Default: -1 returns all branches
since – (optional), Only imported issues after this date willbe returned. This can be adatetime instance, ISO8601formatted date string, or a string formatted like so:2016-02-04 i.e.%Y-%m-%d
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of imported issues

Return type:

invitations(number=-1,etag=None)

Iterate over the invitations to this repository.

Parameters:

number (int) – (optional), number of invitations to return. Default: -1 returnsall available invitations
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of repository invitation objects

Return type:

Invitation

is_assignee(username)

Check if the user can be assigned an issue on this repository.

Parameters:: username (str orUser) – name of the user to check
Returns:: bool

is_collaborator(username)

Check to see ifusername is a collaborator on this repository.

Parameters:: username (str orUser) – (required), login for the user
Returns:: True if successful, False otherwise
Return type:: bool

issue(number)

Get the issue specified bynumber.

Parameters:: number (int) – (required), number of the issue on this repository
Returns:: the issue
Return type:: Issue

issue_events(number=-1,etag=None)

Iterate over issue events on this repository.

Parameters:

number (int) – (optional), number of events to return. Default: -1returns all available events
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of events on issues

Return type:

IssueEvent

issues(milestone=None,state=None,assignee=None,mentioned=None,labels=None,sort=None,direction=None,since=None,number=-1,etag=None)

Iterate over issues on this repo based upon parameters passed.

Changed in version 0.9.0:Thestate parameter now accepts ‘all’ in addition to ‘open’and ‘closed’.

Parameters:

milestone (int) – (optional), ‘none’, or ‘*’
state (str) – (optional), accepted values: (‘all’, ‘open’, ‘closed’)
assignee (str) – (optional), ‘none’, ‘*’, or login name
mentioned (str) – (optional), user’s login name
labels (str) – (optional), comma-separated list of labels, e.g. ‘bug,ui,@high’
sort – (optional), accepted values:(‘created’, ‘updated’, ‘comments’, ‘created’)
direction (str) – (optional), accepted values: (‘asc’, ‘desc’)
since (datetime or str) – (optional), Only issues after this date willbe returned. This can be adatetime or anISO8601 formatteddate string, e.g., 2012-05-20T23:10:27Z
number (int) – (optional), Number of issues to return.By default all issues are returned
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of issues

Return type:

ShortIssue

key(id_num)

Get the specified deploy key.

Parameters:: id_num (int) – (required), id of the key
Returns:: the deploy key
Return type:: Key

keys(number=-1,etag=None)

Iterate over deploy keys on this repository.

Parameters:

number (int) – (optional), number of keys to return. Default: -1returns all available keys
etag (str) – (optional), ETag from a previous request to the sameendpoint

Returns:

generator of keys

Return type:

label(name)

Get the label specified byname.

Parameters:: name (str) – (required), name of the label
Returns:: the label
Return type:: Label

labels(number=-1,etag=None)

Iterate over labels on this repository.

Parameters:

number (int) – (optional), number of labels to return. Default: -1returns all available labels
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of labels

Return type:

languages(number=-1,etag=None)

Iterate over the programming languages used in the repository.

Parameters:

number (int) – (optional), number of languages to return. Default:-1 returns all used languages
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of tuples

Return type:

tuple

latest_pages_build()

Get the build information for the most recent Pages build.

Returns:: the information for the most recent build
Return type:: PagesBuild

latest_release()

Get the latest release.

Draft releases and prereleases are not returned by this endpoint.

Returns:: the release
Return type:: Release

license()

Get the contents of a license for the repo.

Returns:: the license
Return type:: RepositoryLicense

mark_notifications(last_read='')

Mark all notifications in this repository as read.

Parameters:: last_read (str) – (optional), Describes the last point thatnotifications were checked. Anything updated since this time willnot be updated. Default: Now. Expected in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZ. Example: “2012-10-09T23:39:01Z”.
Returns:: True if successful, False otherwise
Return type:: bool

merge(base,head,message='')

Perform a merge fromhead intobase.

Parameters:

base (str) – (required), where you’re merging into
head (str) – (required), where you’re merging from
message (str) – (optional), message to be used for the commit

Returns:

the commit resulting from the merge

Return type:

milestone(number)

Get the milestone indicated bynumber.

Parameters:: number (int) – (required), unique id number of the milestone
Returns:: the milestone
Return type:: Milestone

milestones(state=None,sort=None,direction=None,number=-1,etag=None)

Iterate over the milestones on this repository.

Parameters:

state (str) – (optional), state of the milestones, acceptedvalues: (‘open’, ‘closed’)
sort (str) – (optional), how to sort the milestones, acceptedvalues: (‘due_date’, ‘completeness’)
direction (str) – (optional), direction to sort the milestones,accepted values: (‘asc’, ‘desc’)
number (int) – (optional), number of milestones to return.Default: -1 returns all milestones
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of milestones

Return type:

network_events(number=-1,etag=None)

Iterate over events on a network of repositories.

Parameters:

number (int) – (optional), number of events to return. Default: -1returns all available events
etag (str) – (optional), ETag from a previous request to the sameendpoint

Returns:

generator of events

Return type:

new_session()

Generate a new session.

Returns:: A brand new session
Return type:: GitHubSession

notifications(all=False,participating=False,since=None,number=-1,etag=None)

Iterate over the notifications for this repository.

Parameters:

all (bool) – (optional), show all notifications, including onesmarked as read
participating (bool) – (optional), show only the notifications theuser is participating in directly
since (datetime or str) – (optional), filters out any notifications updatedbefore the given time. This can be adatetime or anISO8601formatted date string, e.g., 2012-05-20T23:10:27Z
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of notification threads

Return type:

Thread

pages()

Get information about this repository’s pages site.

Returns:: information about this repository’s GitHub pages site
Return type:: PagesInfo

pages_builds(number=-1,etag=None)

Iterate over pages builds of this repository.

Parameters:

number (int) – (optional) the number of builds to return
etag (str) – (optional), ETag value from a previous request

Returns:

generator of builds

Return type:

PagesBuild

project(id,etag=None)

Return the organization project with the given ID.

Parameters:: id (int) – (required), ID number of the project
Returns:: the project
Return type:: Project

projects(number=-1,etag=None)

Iterate over projects for this organization.

Parameters:

number (int) – (optional), number of members to return. Default:-1 will return all available.
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of projects

Return type:

pull_request(number)

Get the pull request indicated bynumber.

Parameters:: number (int) – (required), number of the pull request.
Returns:: the pull request
Return type:: PullRequest

pull_requests(state=None,head=None,base=None,sort='created',direction='desc',number=-1,etag=None)

List pull requests on repository.

Changed in version 0.9.0:

Thestate parameter now accepts ‘all’ in addition to ‘open’and ‘closed’.
Thesort parameter was added.
Thedirection parameter was added.

Parameters:

state (str) – (optional), accepted values: (‘all’, ‘open’, ‘closed’)
head (str) – (optional), filters pulls by head user and branchname in the formatuser:ref-name, e.g.,seveas:debian
base (str) – (optional), filter pulls by base branch name.Example:develop.
sort (str) – (optional), Sort pull requests bycreated,updated,popularity,long-running. Default: ‘created’
direction (str) – (optional), Choose the direction to list pullrequests. Accepted values: (‘desc’, ‘asc’). Default: ‘desc’
number (int) – (optional), number of pulls to return. Default: -1returns all available pull requests
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of pull requests

Return type:

propertyratelimit_remaining

Number of requests before GitHub imposes a ratelimit.

Returns:: int

readme()

Get the README for this repository.

Returns:: this repository’s readme
Return type:: Contents

ref(ref)

Get a reference pointed to byref.

Parameters:: ref (str) – (required)
Returns:: the reference
Return type:: Reference

refresh(conditional:bool=False)→GitHubCore

Re-retrieve the information for this object.

The reasoning for the return value is the following example:

repos=[r.refresh()forring.repositories_by('kennethreitz')]

Without the return value, that would be an array ofNone’s and youwould otherwise have to do:

repos=[rforiing.repositories_by('kennethreitz')][r.refresh()forrinrepos]

Which is really an anti-pattern.

Changed in version 0.5.

Parameters:: conditional (bool) – If True, then we will search for a storedheader (‘Last-Modified’, or ‘ETag’) on the object and send thatas described in theConditional Requests section of the docs
Returns:: self

refs(subspace='',number=-1,etag=None)

Iterate over references for this repository.

Parameters:

subspace (str) – (optional), e.g. ‘tags’, ‘stashes’, ‘notes’
number (int) – (optional), number of refs to return. Default: -1returns all available refs
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of references

Return type:

release(id)

Get a single release.

Parameters:: id (int) – (required), id of release
Returns:: the release
Return type:: Release

release_from_tag(tag_name)

Get a release by tag name.

release_from_tag() returns a release with specified tagwhile release() returns a release with specified release id

Parameters:: tag_name (str) – (required) name of tag
Returns:: the release
Return type:: Release

releases(number=-1,etag=None)

Iterate over releases for this repository.

Parameters:

number (int) – (optional), number of refs to return. Default: -1returns all available refs
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of releases

Return type:

remove_collaborator(username)

Remove collaboratorusername from the repository.

Parameters:: username (str orUser) – (required), login name of the collaborator
Returns:: True if successful, False otherwise
Return type:: bool

replace_topics(new_topics)

Replace the repository topics withnew_topics.

Parameters:: topics (list) – (required), new topics of the repository
Returns:: new topics of the repository
Return type:: Topics

stargazers(number=-1,etag=None)

List users who have starred this repository.

Parameters:

number (int) – (optional), number of stargazers to return.Default: -1 returns all subscribers available
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of users

Return type:

Stargazer

statuses(sha,number=-1,etag=None)

Iterate over the statuses for a specific SHA.

Warning

Deprecated in v1.0. Also deprecated upstreamhttps://developer.github.com/v3/repos/statuses/

Parameters:

sha (str) – SHA of the commit to list the statuses of
number (int) – (optional), return up to number statuses. Default:-1 returns all available statuses.
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of statuses

Return type:

subscribe()

Subscribe the user to this repository’s notifications.

New in version 1.0.

This replacesRepository#set_subscription

Returns:: the new repository subscription
Return type:: RepositorySubscription

subscribers(number=-1,etag=None)

Iterate over users subscribed to this repository.

Parameters:

number (int) – (optional), number of subscribers to return.Default: -1 returns all subscribers available
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of users subscribed to this repository

Return type:

http://learn.github.com/p/tagging.html

subscription()

Return subscription for this Repository.

Returns:: the user’s subscription to this repository
Return type:: RepositorySubscription

tag(sha)

Get an annotated tag.

Parameters:: sha (str) – (required), sha of the object for this tag
Returns:: the annotated tag
Return type:: Tag

tags(number=-1,etag=None)

Iterate over tags on this repository.

Parameters:

number (int) – (optional), return up to at most number tags.Default: -1 returns all available tags.
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of tags with GitHub repository specific information

Return type:

RepoTag

teams(number=-1,etag=None)

Iterate over teams with access to this repository.

Parameters:

number (int) – (optional), return up to number Teams. Default: -1returns all Teams.
etag (str) – (optional), ETag from a previous request to the same endpoint

Returns:

generator of teams

Return type:

Team

topics()

Get the topics of this repository.

Returns:: this repository’s topics
Return type:: Topics

tree(sha,recursive=False)

Get a tree.

Parameters:

sha (str) – (required), sha of the object for this tree
recursive (bool) – (optional), whether to fetch the tree recursively

Returns:

the tree

Return type: