JorgeVB/code_unlearning_dataset · Datasets at Hugging Face

text stringlengths 81 112k
Iterate over events performed by this user. :param bool public: (optional), only list public events for the authenticated user :param int number: (optional), number of events to return. Default: -1 returns all available events. :param str etag: (optional), ETag from a pr...
Iterate over the followers of this user. :param int number: (optional), number of followers to return. Default: -1 returns all available :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`User <User>`\ s def ite...
Iterate over the public keys of this user. .. versionadded:: 0.5 :param int number: (optional), number of keys to return. Default: -1 returns all available keys :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of...
Iterate over events as they appear on the user's organization dashboard. You must be authenticated to view this. :param str org: (required), name of the organization :param int number: (optional), number of events to return. Default: -1 returns all available events :param st...
Iterate over organizations the user is member of :param int number: (optional), number of organizations to return. Default: -1 returns all available organization :param str etag: (optional), ETag from a previous request to the same endpoint :returns: list of :class:`Even...
Iterate over repositories starred by this user. .. versionchanged:: 0.5 Added sort and direction parameters (optional) as per the change in GitHub's API. :param int number: (optional), number of starred repos to return. Default: -1, returns all available repos ...
Iterate over repositories subscribed to by this user. :param int number: (optional), number of subscriptions to return. Default: -1, returns all available :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`Reposi...
If authenticated as this user, update the information with the information provided in the parameters. :param str name: e.g., 'John Smith', not login name :param str email: e.g., 'john.smith@example.com' :param str blog: e.g., 'http://www.example.com/jsmith/blog' :param str comp...
Delete subscription for this thread. :returns: bool def delete_subscription(self): """Delete subscription for this thread. :returns: bool """ url = self._build_url('subscription', base_url=self._api) return self._boolean(self._delete(url), 204, 404)
Set the user's subscription for this thread :param bool subscribed: (required), determines if notifications should be received from this thread. :param bool ignored: (required), determines if notifications should be ignored from this thread. :returns: :class:`Subscriptio...
Checks the status of the user's subscription to this thread. :returns: :class:`Subscription <Subscription>` def subscription(self): """Checks the status of the user's subscription to this thread. :returns: :class:`Subscription <Subscription>` """ url = self._build_url('subscri...
Set the user's subscription for this subscription :param bool subscribed: (required), determines if notifications should be received from this thread. :param bool ignored: (required), determines if notifications should be ignored from this thread. def set(self, subscribed, igno...
Examples:: locate_ami(product="com.ubuntu.cloud:server:16.04:amd64", channel="daily", stream="daily", region="us-west-2") locate_ami(product="Amazon Linux AMI 2016.09") def locate_ami(product, region=None, channel="releases", stream="released", root_store="ssd", virt="hvm"): """ Examples:: ...
Add ``login`` as a collaborator to a repository. :param str login: (required), login of the user :returns: bool -- True if successful, False otherwise def add_collaborator(self, login): """Add ``login`` as a collaborator to a repository. :param str login: (required), login of the user...
Get the tarball or zipball archive for this repo at ref. See: http://developer.github.com/v3/repos/contents/#get-archive-link :param str format: (required), accepted values: ('tarball', 'zipball') :param path: (optional), path where the file should be saved to, default ...
Returns a single Asset. :param int id: (required), id of the asset :returns: :class:`Asset <github3.repos.release.Asset>` def asset(self, id): """Returns a single Asset. :param int id: (required), id of the asset :returns: :class:`Asset <github3.repos.release.Asset>` "...
Get the blob indicated by ``sha``. :param str sha: (required), sha of the blob :returns: :class:`Blob <github3.git.Blob>` if successful, otherwise None def blob(self, sha): """Get the blob indicated by ``sha``. :param str sha: (required), sha of the blob :returns: ...
Get the branch ``name`` of this repository. :param str name: (required), branch name :type name: str :returns: :class:`Branch <github3.repos.branch.Branch>` def branch(self, name): """Get the branch ``name`` of this repository. :param str name: (required), branch name ...
Get a single (repo) commit. See :func:`git_commit` for the Git Data Commit. :param str sha: (required), sha of the commit :returns: :class:`RepoCommit <github3.repos.commit.RepoCommit>` if successful, otherwise None def commit(self, sha): """Get a single (repo) commit. See ...
Get a single commit comment. :param int comment_id: (required), id of the comment used by GitHub :returns: :class:`RepoComment <github3.repos.comment.RepoComment>` if successful, otherwise None def commit_comment(self, comment_id): """Get a single commit comment. :param in...
Compare two commits. :param str base: (required), base for the comparison :param str head: (required), compare this against base :returns: :class:`Comparison <github3.repos.comparison.Comparison>` if successful, else None def compare_commits(self, base, head): """Compare tw...
Get the contents of the file pointed to by ``path``. If the path provided is actually a directory, you will receive a dictionary back of the form:: { 'filename.md': Contents(), # Where Contents an instance 'github.py': Contents(), } :pa...
Create a blob with ``content``. :param str content: (required), content of the blob :param str encoding: (required), ('base64', 'utf-8') :returns: string of the SHA returned def create_blob(self, content, encoding): """Create a blob with ``content``. :param str content: (requi...
Create a comment on a commit. :param str body: (required), body of the message :param str sha: (required), commit id :param str path: (optional), relative path of the file to comment on :param str position: (optional), line index in the diff to comment on :param int ...
Create a commit on this repository. :param str message: (required), commit message :param str tree: (required), SHA of the tree object this commit points to :param list parents: (required), SHAs of the commits that were parents of this commit. If empty, the commit will b...
Create a deployment. :param str ref: (required), The ref to deploy. This can be a branch, tag, or sha. :param bool force: Optional parameter to bypass any ahead/behind checks or commit status checks. Default: False :param str payload: Optional JSON payload with extra inf...
Create a file in this repository. See also: http://developer.github.com/v3/repos/contents/#create-a-file :param str path: (required), path of the file in the repository :param str message: (required), commit message :param bytes content: (required), the actual data in the file ...
Create a fork of this repository. :param str organization: (required), login for organization to create the fork under :returns: :class:`Repository <Repository>` if successful, else None def create_fork(self, organization=None): """Create a fork of this repository. :param ...
Create a hook on this repository. :param str name: (required), name of the hook :param dict config: (required), key-value pairs which act as settings for this hook :param list events: (optional), events the hook is triggered for :param bool active: (optional), whether the ho...
Creates an issue on this repository. :param str title: (required), title of the issue :param str body: (optional), body of the issue :param str assignee: (optional), login of the user to assign the issue to :param int milestone: (optional), id number of the milestone to ...
Create a deploy key. :param str title: (required), title of key :param str key: (required), key text :returns: :class:`Key <github3.users.Key>` if successful, else None def create_key(self, title, key): """Create a deploy key. :param str title: (required), title of key ...
Create a label for this repository. :param str name: (required), name to give to the label :param str color: (required), value of the color to assign to the label, e.g., '#fafafa' or 'fafafa' (the latter is what is sent) :returns: :class:`Label <github3.issues.label.Label>` if succe...
Create a milestone for this repository. :param str title: (required), title of the milestone :param str state: (optional), state of the milestone, accepted values: ('open', 'closed'), default: 'open' :param str description: (optional), description of the milestone :param str...
Create a pull request of ``head`` onto ``base`` branch in this repo. :param str title: (required) :param str base: (required), e.g., 'master' :param str head: (required), e.g., 'username:branch' :param str body: (optional), markdown formatted description :returns: :class:`PullRe...
Create a pull request from issue #``issue``. :param int issue: (required), issue number :param str base: (required), e.g., 'master' :param str head: (required), e.g., 'username:branch' :returns: :class:`PullRequest <github3.pulls.PullRequest>` if successful, else None def c...
Create a reference in this repository. :param str ref: (required), fully qualified name of the reference, e.g. ``refs/heads/master``. If it doesn't start with ``refs`` and contain at least two slashes, GitHub's API will reject it. :param str sha: (required), SHA1 value to set th...
Create a release for this repository. :param str tag_name: (required), name to give to the tag :param str target_commitish: (optional), vague concept of a target, either a SHA or a branch name. :param str name: (optional), name of the release :param str body: (optional), des...
Create a status object on a commit. :param str sha: (required), SHA of the commit to create the status on :param str state: (required), state of the test; only the following are accepted: 'pending', 'success', 'error', 'failure' :param str target_url: (optional), URL to associate wi...
Create a tag in this repository. :param str tag: (required), name of the tag :param str message: (required), tag message :param str sha: (required), SHA of the git object this is tagging :param str obj_type: (required), type of object being tagged, e.g., 'commit', 'tree', 'b...
Create a tree on this repository. :param list tree: (required), specifies the tree structure. Format: [{'path': 'path/file', 'mode': 'filemode', 'type': 'blob or tree', 'sha': '44bfc6d...'}] :param str base_tree: (optional), SHA1 of the tree you want to update with n...
Delete the file located at ``path``. This is part of the Contents CrUD (Create Update Delete) API. See http://developer.github.com/v3/repos/contents/#delete-a-file for more information. :param str path: (required), path to the file being removed :param str message: (required), ...
Delete the key with the specified id from your deploy keys list. :returns: bool -- True if successful, False otherwise def delete_key(self, key_id): """Delete the key with the specified id from your deploy keys list. :returns: bool -- True if successful, False otherwise """ if...
Edit this repository. :param str name: (required), name of the repository :param str description: (optional), If not ``None``, change the description for this repository. API default: ``None`` - leave value unchanged. :param str homepage: (optional), If not ``None``, cha...
Get a single (git) commit. :param str sha: (required), sha of the commit :returns: :class:`Commit <github3.git.Commit>` if successful, otherwise None def git_commit(self, sha): """Get a single (git) commit. :param str sha: (required), sha of the commit :returns: :c...
Get a single hook. :param int id_num: (required), id of the hook :returns: :class:`Hook <github3.repos.hook.Hook>` if successful, otherwise None def hook(self, id_num): """Get a single hook. :param int id_num: (required), id of the hook :returns: :class:`Hook <gith...
Check if the user is a possible assignee for an issue on this repository. :returns: :class:`bool` def is_assignee(self, login): """Check if the user is a possible assignee for an issue on this repository. :returns: :class:`bool` """ if not login: re...
Get the issue specified by ``number``. :param int number: (required), number of the issue on this repository :returns: :class:`Issue <github3.issues.issue.Issue>` if successful, otherwise None def issue(self, number): """Get the issue specified by ``number``. :param int nu...
Get the specified deploy key. :param int id_num: (required), id of the key :returns: :class:`Key <github3.users.Key>` if successful, else None def key(self, id_num): """Get the specified deploy key. :param int id_num: (required), id of the key :returns: :class:`Key <github3.us...
Get the label specified by ``name`` :param str name: (required), name of the label :returns: :class:`Label <github3.issues.label.Label>` if successful, else None def label(self, name): """Get the label specified by ``name`` :param str name: (required), name of the label ...
Iterate over the branches in this repository. :param int number: (optional), number of branches to return. Default: -1 returns all branches :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`Branch <g...
Iterate over the code frequency per week. Returns a weekly aggregate of the number of additions and deletions pushed to this repository. :param int number: (optional), number of weeks to return. Default: -1 returns all weeks :param str etag: (optional), ETag from a previous...
Iterate over comments for a single commit. :param sha: (required), sha of the commit to list comments on :type sha: str :param int number: (optional), number of comments to return. Default: -1 returns all comments :param str etag: (optional), ETag from a previous request to ...
Iterate over last year of commit activity by week. See: http://developer.github.com/v3/repos/statistics/ :param int number: (optional), number of weeks to return. Default -1 will return all of the weeks. :param str etag: (optional), ETag from a previous request to the same ...
Iterate over commits in this repository. :param str sha: (optional), sha or branch to start listing commits from :param str path: (optional), commits containing this path will be listed :param str author: (optional), GitHub login, real name, or email to filte...
Iterate over the contributors to this repository. :param bool anon: (optional), True lists anonymous contributors as well :param int number: (optional), number of contributors to return. Default: -1 returns all contributors :param str etag: (optional), ETag from a previo...
Iterate over the contributors list. See also: http://developer.github.com/v3/repos/statistics/ :param int number: (optional), number of weeks to return. Default -1 will return all of the weeks. :param str etag: (optional), ETag from a previous request to the same endpoi...
Iterate over deployments for this repository. :param int number: (optional), number of deployments to return. Default: -1, returns all available deployments :param str etag: (optional), ETag from a previous request for all deployments :returns: generator of :...
Iterate over forks of this repository. :param str sort: (optional), accepted values: ('newest', 'oldest', 'watchers'), API default: 'newest' :param int number: (optional), number of forks to return. Default: -1 returns all forks :param str etag: (optional), ETag from a p...
Iterate over hooks registered on this repository. :param int number: (optional), number of hoks to return. Default: -1 returns all hooks :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`Hook <github3.repos.hook...
Iterate over issues on this repo based upon parameters passed. .. versionchanged:: 0.9.0 The ``state`` parameter now accepts 'all' in addition to 'open' and 'closed'. :param int milestone: (optional), 'none', or '*' :param str state: (optional), accepted values: ('all'...
Iterates over issue events on this repository. :param int number: (optional), number of events to return. Default: -1 returns all available events :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`Is...
Iterate over the programming languages used in the repository. :param int number: (optional), number of languages to return. Default: -1 returns all used languages :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of tuple...
Iterates over the milestones on this repository. :param str state: (optional), state of the milestones, accepted values: ('open', 'closed') :param str sort: (optional), how to sort the milestones, accepted values: ('due_date', 'completeness') :param str direction: (optio...
Iterates over events on a network of repositories. :param int number: (optional), number of events to return. Default: -1 returns all available events :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`Event <git...
Iterates over the notifications for this repository. :param bool all: (optional), show all notifications, including ones marked as read :param bool participating: (optional), show only the notifications the user is participating in directly :param since: (optional), filt...
Iterate over pages builds of this repository. :returns: generator of :class:`PagesBuild <github3.repos.pages.PagesBuild>` def iter_pages_builds(self, number=-1, etag=None): """Iterate over pages builds of this repository. :returns: generator of :class:`PagesBuild <gith...
List pull requests on repository. .. versionchanged:: 0.9.0 - The ``state`` parameter now accepts 'all' in addition to 'open' and 'closed'. - The ``sort`` parameter was added. - The ``direction`` parameter was added. :param str state: (optional), ac...
Iterates over references for this repository. :param str subspace: (optional), e.g. 'tags', 'stashes', 'notes' :param int number: (optional), number of refs to return. Default: -1 returns all available refs :param str etag: (optional), ETag from a previous request to the same ...
Iterates over releases for this repository. :param int number: (optional), number of refs to return. Default: -1 returns all available refs :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`Release <...
Iterates over the statuses for a specific SHA. :param str sha: SHA of the commit to list the statuses of :param int number: (optional), return up to number statuses. Default: -1 returns all available statuses. :param str etag: (optional), ETag from a previous request to the same ...
Iterates over tags on this repository. :param int number: (optional), return up to at most number tags. Default: -1 returns all available tags. :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`RepoTag <github3....
Mark all notifications in this repository as read. :param str last_read: (optional), Describes the last point that notifications were checked. Anything updated since this time will not be updated. Default: Now. Expected in ISO 8601 format: ``YYYY-MM-DDTHH:MM:SSZ``. Example: ...
Perform a merge from ``head`` into ``base``. :param str base: (required), where you're merging into :param str head: (required), where you're merging from :param str message: (optional), message to be used for the commit :returns: :class:`RepoCommit <github3.repos.commit.RepoCommit>` d...
Get the milestone indicated by ``number``. :param int number: (required), unique id number of the milestone :returns: :class:`Milestone <github3.issues.milestone.Milestone>` def milestone(self, number): """Get the milestone indicated by ``number``. :param int number: (required), uniqu...
Get information about this repository's pages site. :returns: :class:`PagesInfo <github3.repos.pages.PagesInfo>` def pages(self): """Get information about this repository's pages site. :returns: :class:`PagesInfo <github3.repos.pages.PagesInfo>` """ url = self._build_url('page...
Get the pull request indicated by ``number``. :param int number: (required), number of the pull request. :returns: :class:`PullRequest <github3.pulls.PullRequest>` def pull_request(self, number): """Get the pull request indicated by ``number``. :param int number: (required), number of...
Get the README for this repository. :returns: :class:`Contents <github3.repos.contents.Contents>` def readme(self): """Get the README for this repository. :returns: :class:`Contents <github3.repos.contents.Contents>` """ url = self._build_url('readme', base_url=self._api) ...
Get a reference pointed to by ``ref``. The most common will be branches and tags. For a branch, you must specify '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 t...
Get a single release. :param int id: (required), id of release :returns: :class:`Release <github3.repos.release.Release>` def release(self, id): """Get a single release. :param int id: (required), id of release :returns: :class:`Release <github3.repos.release.Release>` ...
Remove collaborator ``login`` from the repository. :param str login: (required), login name of the collaborator :returns: bool def remove_collaborator(self, login): """Remove collaborator ``login`` from the repository. :param str login: (required), login name of the collaborator ...
Get an annotated tag. http://learn.github.com/p/tagging.html :param str sha: (required), sha of the object for this tag :returns: :class:`Tag <github3.git.Tag>` def tag(self, sha): """Get an annotated tag. http://learn.github.com/p/tagging.html :param str sha: (requi...
Get a tree. :param str sha: (required), sha of the object for this tree :returns: :class:`Tree <github3.git.Tree>` def tree(self, sha): """Get a tree. :param str sha: (required), sha of the object for this tree :returns: :class:`Tree <github3.git.Tree>` """ jso...
Update the label ``name``. :param str name: (required), name of the label :param str color: (required), color code :param str new_name: (optional), new name of the label :returns: bool def update_label(self, name, color, new_name=''): """Update the label ``name``. :par...
Returns the total commit counts. The dictionary returned has two entries: ``all`` and ``owner``. Each has a fifty-two element long list of commit counts. (Note: ``all`` includes the owner.) ``d['all'][0]`` will be the oldest week, ``d['all'][51]`` will be the most recent. :retu...
Supply two names: Existing instance name or ID, and new name to assign to the instance. def rename(args): """Supply two names: Existing instance name or ID, and new name to assign to the instance.""" old_name, new_name = args.names add_tags(resources.ec2.Instance(resolve_instance_id(old_name)), Name=new_na...
Create a new deployment status for this deployment. :param str state: (required), The state of the status. Can be one of ``pending``, ``success``, ``error``, or ``failure``. :param str target_url: The target URL to associate with this status. This URL should contain output to ke...
Iterate over the deployment statuses for this deployment. :param int number: (optional), the number of statuses to return. Default: -1, returns all statuses. :param str etag: (optional), the ETag header value from the last time you iterated over the statuses. :returns: g...
Retrieve the gist at this version. :returns: :class:`Gist <github3.gists.gist.Gist>` def get_gist(self): """Retrieve the gist at this version. :returns: :class:`Gist <github3.gists.gist.Gist>` """ from .gist import Gist json = self._json(self._get(self._api), 200) ...
Update this reference. :param str sha: (required), sha of the reference :param bool force: (optional), force the update or not :returns: bool def update(self, sha, force=False): """Update this reference. :param str sha: (required), sha of the reference :param bool forc...
Recurse into the tree. :returns: :class:`Tree <Tree>` def recurse(self): """Recurse into the tree. :returns: :class:`Tree <Tree>` """ json = self._json(self._get(self._api, params={'recursive': '1'}), 200) return Tree(json, self._session) if j...
Table pretty printer. Expects tables to be given as arrays of arrays:: print(format_table([[1, "2"], [3, "456"]], column_names=['A', 'B'])) def format_table(table, column_names=None, column_specs=None, max_col_width=32, auto_col_width=False): """ Table pretty printer. Expects tables to be given as arr...
Get an Aegea configuration parameter by name def get(args): """Get an Aegea configuration parameter by name""" from . import config for key in args.key.split("."): config = getattr(config, key) print(json.dumps(config))
Set an Aegea configuration parameter to a given value def set(args): """Set an Aegea configuration parameter to a given value""" from . import config, tweak class ConfigSaver(tweak.Config): @property def config_files(self): return [config.config_files[2]] config_saver = Co...
Obtain an authorization token for the GitHub API. :param str login: (required) :param str password: (required) :param list scopes: (required), areas you want this token to apply to, i.e., 'gist', 'user' :param str note: (optional), note about the authorization :param str note_url: (optional...
Construct and return an authenticated GitHub session. This will return a GitHubEnterprise session if a url is provided. :param str username: login name :param str password: password for the login :param str token: OAuth token :param str url: (optional), URL of a GitHub Enterprise instance :par...
List the followers of ``username``. :param str username: (required), login of the person to list the followers of :param int number: (optional), number of followers to return, Default: -1, return all of them :param str etag: (optional), ETag from a previous request to the same endpo...
List the people ``username`` follows. :param str username: (required), login of the user :param int number: (optional), number of users being followed by username to return. Default: -1, return all of them :param str etag: (optional), ETag from a previous request to the same endpoint :r...
List issues on owner/repository. Only owner and repository are required. .. versionchanged:: 0.9.0 - The ``state`` parameter now accepts 'all' in addition to 'open' and 'closed'. :param str owner: login of the owner of the repository :param str repository: name of the repository ...
List the organizations associated with ``username``. :param str username: (required), login of the user :param int number: (optional), number of orgs to return. Default: -1, return all of the issues :param str etag: (optional), ETag from a previous request to the same endpoint :returns:...
List public repositories for the specified ``login``. .. versionadded:: 0.6 .. note:: This replaces github3.iter_repos :param str login: (required) :param str type: (optional), accepted values: ('all', 'owner', 'member') API default: 'all' :param str sort: (optional), accepted val...

Iterate over events performed by this user. :param bool public: (optional), only list public events for the authenticated user :param int number: (optional), number of events to return. Default: -1 returns all available events. :param str etag: (optional), ETag from a pr...

Iterate over the followers of this user. :param int number: (optional), number of followers to return. Default: -1 returns all available :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`User <User>`\ s def ite...

Iterate over the public keys of this user. .. versionadded:: 0.5 :param int number: (optional), number of keys to return. Default: -1 returns all available keys :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of...

Iterate over events as they appear on the user's organization dashboard. You must be authenticated to view this. :param str org: (required), name of the organization :param int number: (optional), number of events to return. Default: -1 returns all available events :param st...

Iterate over organizations the user is member of :param int number: (optional), number of organizations to return. Default: -1 returns all available organization :param str etag: (optional), ETag from a previous request to the same endpoint :returns: list of :class:`Even...

Iterate over repositories starred by this user. .. versionchanged:: 0.5 Added sort and direction parameters (optional) as per the change in GitHub's API. :param int number: (optional), number of starred repos to return. Default: -1, returns all available repos ...

Iterate over repositories subscribed to by this user. :param int number: (optional), number of subscriptions to return. Default: -1, returns all available :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`Reposi...

If authenticated as this user, update the information with the information provided in the parameters. :param str name: e.g., 'John Smith', not login name :param str email: e.g., 'john.smith@example.com' :param str blog: e.g., 'http://www.example.com/jsmith/blog' :param str comp...

Delete subscription for this thread. :returns: bool def delete_subscription(self): """Delete subscription for this thread. :returns: bool """ url = self._build_url('subscription', base_url=self._api) return self._boolean(self._delete(url), 204, 404)

Set the user's subscription for this thread :param bool subscribed: (required), determines if notifications should be received from this thread. :param bool ignored: (required), determines if notifications should be ignored from this thread. :returns: :class:`Subscriptio...

Checks the status of the user's subscription to this thread. :returns: :class:`Subscription <Subscription>` def subscription(self): """Checks the status of the user's subscription to this thread. :returns: :class:`Subscription <Subscription>` """ url = self._build_url('subscri...

Set the user's subscription for this subscription :param bool subscribed: (required), determines if notifications should be received from this thread. :param bool ignored: (required), determines if notifications should be ignored from this thread. def set(self, subscribed, igno...

Examples:: locate_ami(product="com.ubuntu.cloud:server:16.04:amd64", channel="daily", stream="daily", region="us-west-2") locate_ami(product="Amazon Linux AMI 2016.09") def locate_ami(product, region=None, channel="releases", stream="released", root_store="ssd", virt="hvm"): """ Examples:: ...

Add ``login`` as a collaborator to a repository. :param str login: (required), login of the user :returns: bool -- True if successful, False otherwise def add_collaborator(self, login): """Add ``login`` as a collaborator to a repository. :param str login: (required), login of the user...

Get the tarball or zipball archive for this repo at ref. See: http://developer.github.com/v3/repos/contents/#get-archive-link :param str format: (required), accepted values: ('tarball', 'zipball') :param path: (optional), path where the file should be saved to, default ...

Returns a single Asset. :param int id: (required), id of the asset :returns: :class:`Asset <github3.repos.release.Asset>` def asset(self, id): """Returns a single Asset. :param int id: (required), id of the asset :returns: :class:`Asset <github3.repos.release.Asset>` "...

Get the blob indicated by ``sha``. :param str sha: (required), sha of the blob :returns: :class:`Blob <github3.git.Blob>` if successful, otherwise None def blob(self, sha): """Get the blob indicated by ``sha``. :param str sha: (required), sha of the blob :returns: ...

Get the branch ``name`` of this repository. :param str name: (required), branch name :type name: str :returns: :class:`Branch <github3.repos.branch.Branch>` def branch(self, name): """Get the branch ``name`` of this repository. :param str name: (required), branch name ...

Get a single (repo) commit. See :func:`git_commit` for the Git Data Commit. :param str sha: (required), sha of the commit :returns: :class:`RepoCommit <github3.repos.commit.RepoCommit>` if successful, otherwise None def commit(self, sha): """Get a single (repo) commit. See ...

Get a single commit comment. :param int comment_id: (required), id of the comment used by GitHub :returns: :class:`RepoComment <github3.repos.comment.RepoComment>` if successful, otherwise None def commit_comment(self, comment_id): """Get a single commit comment. :param in...

Compare two commits. :param str base: (required), base for the comparison :param str head: (required), compare this against base :returns: :class:`Comparison <github3.repos.comparison.Comparison>` if successful, else None def compare_commits(self, base, head): """Compare tw...

Get the contents of the file pointed to by ``path``. If the path provided is actually a directory, you will receive a dictionary back of the form:: { 'filename.md': Contents(), # Where Contents an instance 'github.py': Contents(), } :pa...

Create a blob with ``content``. :param str content: (required), content of the blob :param str encoding: (required), ('base64', 'utf-8') :returns: string of the SHA returned def create_blob(self, content, encoding): """Create a blob with ``content``. :param str content: (requi...

Create a comment on a commit. :param str body: (required), body of the message :param str sha: (required), commit id :param str path: (optional), relative path of the file to comment on :param str position: (optional), line index in the diff to comment on :param int ...

Create a commit on this repository. :param str message: (required), commit message :param str tree: (required), SHA of the tree object this commit points to :param list parents: (required), SHAs of the commits that were parents of this commit. If empty, the commit will b...

Create a deployment. :param str ref: (required), The ref to deploy. This can be a branch, tag, or sha. :param bool force: Optional parameter to bypass any ahead/behind checks or commit status checks. Default: False :param str payload: Optional JSON payload with extra inf...

Create a file in this repository. See also: http://developer.github.com/v3/repos/contents/#create-a-file :param str path: (required), path of the file in the repository :param str message: (required), commit message :param bytes content: (required), the actual data in the file ...

Create a fork of this repository. :param str organization: (required), login for organization to create the fork under :returns: :class:`Repository <Repository>` if successful, else None def create_fork(self, organization=None): """Create a fork of this repository. :param ...

Create a hook on this repository. :param str name: (required), name of the hook :param dict config: (required), key-value pairs which act as settings for this hook :param list events: (optional), events the hook is triggered for :param bool active: (optional), whether the ho...

Creates an issue on this repository. :param str title: (required), title of the issue :param str body: (optional), body of the issue :param str assignee: (optional), login of the user to assign the issue to :param int milestone: (optional), id number of the milestone to ...

Create a deploy key. :param str title: (required), title of key :param str key: (required), key text :returns: :class:`Key <github3.users.Key>` if successful, else None def create_key(self, title, key): """Create a deploy key. :param str title: (required), title of key ...

Create a label for this repository. :param str name: (required), name to give to the label :param str color: (required), value of the color to assign to the label, e.g., '#fafafa' or 'fafafa' (the latter is what is sent) :returns: :class:`Label <github3.issues.label.Label>` if succe...

Create a milestone for this repository. :param str title: (required), title of the milestone :param str state: (optional), state of the milestone, accepted values: ('open', 'closed'), default: 'open' :param str description: (optional), description of the milestone :param str...

Create a pull request of ``head`` onto ``base`` branch in this repo. :param str title: (required) :param str base: (required), e.g., 'master' :param str head: (required), e.g., 'username:branch' :param str body: (optional), markdown formatted description :returns: :class:`PullRe...

Create a pull request from issue #``issue``. :param int issue: (required), issue number :param str base: (required), e.g., 'master' :param str head: (required), e.g., 'username:branch' :returns: :class:`PullRequest <github3.pulls.PullRequest>` if successful, else None def c...

Create a reference in this repository. :param str ref: (required), fully qualified name of the reference, e.g. ``refs/heads/master``. If it doesn't start with ``refs`` and contain at least two slashes, GitHub's API will reject it. :param str sha: (required), SHA1 value to set th...

Create a release for this repository. :param str tag_name: (required), name to give to the tag :param str target_commitish: (optional), vague concept of a target, either a SHA or a branch name. :param str name: (optional), name of the release :param str body: (optional), des...

Create a status object on a commit. :param str sha: (required), SHA of the commit to create the status on :param str state: (required), state of the test; only the following are accepted: 'pending', 'success', 'error', 'failure' :param str target_url: (optional), URL to associate wi...

Create a tag in this repository. :param str tag: (required), name of the tag :param str message: (required), tag message :param str sha: (required), SHA of the git object this is tagging :param str obj_type: (required), type of object being tagged, e.g., 'commit', 'tree', 'b...

Create a tree on this repository. :param list tree: (required), specifies the tree structure. Format: [{'path': 'path/file', 'mode': 'filemode', 'type': 'blob or tree', 'sha': '44bfc6d...'}] :param str base_tree: (optional), SHA1 of the tree you want to update with n...

Delete the file located at ``path``. This is part of the Contents CrUD (Create Update Delete) API. See http://developer.github.com/v3/repos/contents/#delete-a-file for more information. :param str path: (required), path to the file being removed :param str message: (required), ...

Delete the key with the specified id from your deploy keys list. :returns: bool -- True if successful, False otherwise def delete_key(self, key_id): """Delete the key with the specified id from your deploy keys list. :returns: bool -- True if successful, False otherwise """ if...

Edit this repository. :param str name: (required), name of the repository :param str description: (optional), If not ``None``, change the description for this repository. API default: ``None`` - leave value unchanged. :param str homepage: (optional), If not ``None``, cha...

Get a single (git) commit. :param str sha: (required), sha of the commit :returns: :class:`Commit <github3.git.Commit>` if successful, otherwise None def git_commit(self, sha): """Get a single (git) commit. :param str sha: (required), sha of the commit :returns: :c...

Get a single hook. :param int id_num: (required), id of the hook :returns: :class:`Hook <github3.repos.hook.Hook>` if successful, otherwise None def hook(self, id_num): """Get a single hook. :param int id_num: (required), id of the hook :returns: :class:`Hook <gith...

Check if the user is a possible assignee for an issue on this repository. :returns: :class:`bool` def is_assignee(self, login): """Check if the user is a possible assignee for an issue on this repository. :returns: :class:`bool` """ if not login: re...

Get the issue specified by ``number``. :param int number: (required), number of the issue on this repository :returns: :class:`Issue <github3.issues.issue.Issue>` if successful, otherwise None def issue(self, number): """Get the issue specified by ``number``. :param int nu...

Get the specified deploy key. :param int id_num: (required), id of the key :returns: :class:`Key <github3.users.Key>` if successful, else None def key(self, id_num): """Get the specified deploy key. :param int id_num: (required), id of the key :returns: :class:`Key <github3.us...

Get the label specified by ``name`` :param str name: (required), name of the label :returns: :class:`Label <github3.issues.label.Label>` if successful, else None def label(self, name): """Get the label specified by ``name`` :param str name: (required), name of the label ...

Iterate over the branches in this repository. :param int number: (optional), number of branches to return. Default: -1 returns all branches :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`Branch <g...

Iterate over the code frequency per week. Returns a weekly aggregate of the number of additions and deletions pushed to this repository. :param int number: (optional), number of weeks to return. Default: -1 returns all weeks :param str etag: (optional), ETag from a previous...

Iterate over comments for a single commit. :param sha: (required), sha of the commit to list comments on :type sha: str :param int number: (optional), number of comments to return. Default: -1 returns all comments :param str etag: (optional), ETag from a previous request to ...

Iterate over last year of commit activity by week. See: http://developer.github.com/v3/repos/statistics/ :param int number: (optional), number of weeks to return. Default -1 will return all of the weeks. :param str etag: (optional), ETag from a previous request to the same ...

Iterate over commits in this repository. :param str sha: (optional), sha or branch to start listing commits from :param str path: (optional), commits containing this path will be listed :param str author: (optional), GitHub login, real name, or email to filte...

Iterate over the contributors to this repository. :param bool anon: (optional), True lists anonymous contributors as well :param int number: (optional), number of contributors to return. Default: -1 returns all contributors :param str etag: (optional), ETag from a previo...

Iterate over the contributors list. See also: http://developer.github.com/v3/repos/statistics/ :param int number: (optional), number of weeks to return. Default -1 will return all of the weeks. :param str etag: (optional), ETag from a previous request to the same endpoi...

Iterate over deployments for this repository. :param int number: (optional), number of deployments to return. Default: -1, returns all available deployments :param str etag: (optional), ETag from a previous request for all deployments :returns: generator of :...

Iterate over forks of this repository. :param str sort: (optional), accepted values: ('newest', 'oldest', 'watchers'), API default: 'newest' :param int number: (optional), number of forks to return. Default: -1 returns all forks :param str etag: (optional), ETag from a p...

Iterate over hooks registered on this repository. :param int number: (optional), number of hoks to return. Default: -1 returns all hooks :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`Hook <github3.repos.hook...

Iterate over issues on this repo based upon parameters passed. .. versionchanged:: 0.9.0 The ``state`` parameter now accepts 'all' in addition to 'open' and 'closed'. :param int milestone: (optional), 'none', or '*' :param str state: (optional), accepted values: ('all'...

Iterates over issue events on this repository. :param int number: (optional), number of events to return. Default: -1 returns all available events :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`Is...

Iterate over the programming languages used in the repository. :param int number: (optional), number of languages to return. Default: -1 returns all used languages :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of tuple...

Iterates over the milestones on this repository. :param str state: (optional), state of the milestones, accepted values: ('open', 'closed') :param str sort: (optional), how to sort the milestones, accepted values: ('due_date', 'completeness') :param str direction: (optio...

Iterates over events on a network of repositories. :param int number: (optional), number of events to return. Default: -1 returns all available events :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`Event <git...

Iterates over the notifications for this repository. :param bool all: (optional), show all notifications, including ones marked as read :param bool participating: (optional), show only the notifications the user is participating in directly :param since: (optional), filt...

Iterate over pages builds of this repository. :returns: generator of :class:`PagesBuild <github3.repos.pages.PagesBuild>` def iter_pages_builds(self, number=-1, etag=None): """Iterate over pages builds of this repository. :returns: generator of :class:`PagesBuild <gith...

List pull requests on repository. .. versionchanged:: 0.9.0 - The ``state`` parameter now accepts 'all' in addition to 'open' and 'closed'. - The ``sort`` parameter was added. - The ``direction`` parameter was added. :param str state: (optional), ac...

Iterates over references for this repository. :param str subspace: (optional), e.g. 'tags', 'stashes', 'notes' :param int number: (optional), number of refs to return. Default: -1 returns all available refs :param str etag: (optional), ETag from a previous request to the same ...

Iterates over releases for this repository. :param int number: (optional), number of refs to return. Default: -1 returns all available refs :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`Release <...

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

Iterates over tags on this repository. :param int number: (optional), return up to at most number tags. Default: -1 returns all available tags. :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`RepoTag <github3....

Mark all notifications in this repository as read. :param str last_read: (optional), Describes the last point that notifications were checked. Anything updated since this time will not be updated. Default: Now. Expected in ISO 8601 format: ``YYYY-MM-DDTHH:MM:SSZ``. Example: ...

Perform a merge from ``head`` into ``base``. :param str base: (required), where you're merging into :param str head: (required), where you're merging from :param str message: (optional), message to be used for the commit :returns: :class:`RepoCommit <github3.repos.commit.RepoCommit>` d...

Get the milestone indicated by ``number``. :param int number: (required), unique id number of the milestone :returns: :class:`Milestone <github3.issues.milestone.Milestone>` def milestone(self, number): """Get the milestone indicated by ``number``. :param int number: (required), uniqu...

Get information about this repository's pages site. :returns: :class:`PagesInfo <github3.repos.pages.PagesInfo>` def pages(self): """Get information about this repository's pages site. :returns: :class:`PagesInfo <github3.repos.pages.PagesInfo>` """ url = self._build_url('page...

Get the pull request indicated by ``number``. :param int number: (required), number of the pull request. :returns: :class:`PullRequest <github3.pulls.PullRequest>` def pull_request(self, number): """Get the pull request indicated by ``number``. :param int number: (required), number of...

Get the README for this repository. :returns: :class:`Contents <github3.repos.contents.Contents>` def readme(self): """Get the README for this repository. :returns: :class:`Contents <github3.repos.contents.Contents>` """ url = self._build_url('readme', base_url=self._api) ...

Get a reference pointed to by ``ref``. The most common will be branches and tags. For a branch, you must specify '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 t...

Get a single release. :param int id: (required), id of release :returns: :class:`Release <github3.repos.release.Release>` def release(self, id): """Get a single release. :param int id: (required), id of release :returns: :class:`Release <github3.repos.release.Release>` ...

Remove collaborator ``login`` from the repository. :param str login: (required), login name of the collaborator :returns: bool def remove_collaborator(self, login): """Remove collaborator ``login`` from the repository. :param str login: (required), login name of the collaborator ...

Get an annotated tag. http://learn.github.com/p/tagging.html :param str sha: (required), sha of the object for this tag :returns: :class:`Tag <github3.git.Tag>` def tag(self, sha): """Get an annotated tag. http://learn.github.com/p/tagging.html :param str sha: (requi...

Get a tree. :param str sha: (required), sha of the object for this tree :returns: :class:`Tree <github3.git.Tree>` def tree(self, sha): """Get a tree. :param str sha: (required), sha of the object for this tree :returns: :class:`Tree <github3.git.Tree>` """ jso...

Update the label ``name``. :param str name: (required), name of the label :param str color: (required), color code :param str new_name: (optional), new name of the label :returns: bool def update_label(self, name, color, new_name=''): """Update the label ``name``. :par...

Returns the total commit counts. The dictionary returned has two entries: ``all`` and ``owner``. Each has a fifty-two element long list of commit counts. (Note: ``all`` includes the owner.) ``d['all'][0]`` will be the oldest week, ``d['all'][51]`` will be the most recent. :retu...

Supply two names: Existing instance name or ID, and new name to assign to the instance. def rename(args): """Supply two names: Existing instance name or ID, and new name to assign to the instance.""" old_name, new_name = args.names add_tags(resources.ec2.Instance(resolve_instance_id(old_name)), Name=new_na...

Create a new deployment status for this deployment. :param str state: (required), The state of the status. Can be one of ``pending``, ``success``, ``error``, or ``failure``. :param str target_url: The target URL to associate with this status. This URL should contain output to ke...

Iterate over the deployment statuses for this deployment. :param int number: (optional), the number of statuses to return. Default: -1, returns all statuses. :param str etag: (optional), the ETag header value from the last time you iterated over the statuses. :returns: g...

Retrieve the gist at this version. :returns: :class:`Gist <github3.gists.gist.Gist>` def get_gist(self): """Retrieve the gist at this version. :returns: :class:`Gist <github3.gists.gist.Gist>` """ from .gist import Gist json = self._json(self._get(self._api), 200) ...

Update this reference. :param str sha: (required), sha of the reference :param bool force: (optional), force the update or not :returns: bool def update(self, sha, force=False): """Update this reference. :param str sha: (required), sha of the reference :param bool forc...

Recurse into the tree. :returns: :class:`Tree <Tree>` def recurse(self): """Recurse into the tree. :returns: :class:`Tree <Tree>` """ json = self._json(self._get(self._api, params={'recursive': '1'}), 200) return Tree(json, self._session) if j...

Table pretty printer. Expects tables to be given as arrays of arrays:: print(format_table([[1, "2"], [3, "456"]], column_names=['A', 'B'])) def format_table(table, column_names=None, column_specs=None, max_col_width=32, auto_col_width=False): """ Table pretty printer. Expects tables to be given as arr...

Get an Aegea configuration parameter by name def get(args): """Get an Aegea configuration parameter by name""" from . import config for key in args.key.split("."): config = getattr(config, key) print(json.dumps(config))

Set an Aegea configuration parameter to a given value def set(args): """Set an Aegea configuration parameter to a given value""" from . import config, tweak class ConfigSaver(tweak.Config): @property def config_files(self): return [config.config_files[2]] config_saver = Co...

Obtain an authorization token for the GitHub API. :param str login: (required) :param str password: (required) :param list scopes: (required), areas you want this token to apply to, i.e., 'gist', 'user' :param str note: (optional), note about the authorization :param str note_url: (optional...

Construct and return an authenticated GitHub session. This will return a GitHubEnterprise session if a url is provided. :param str username: login name :param str password: password for the login :param str token: OAuth token :param str url: (optional), URL of a GitHub Enterprise instance :par...

List the followers of ``username``. :param str username: (required), login of the person to list the followers of :param int number: (optional), number of followers to return, Default: -1, return all of them :param str etag: (optional), ETag from a previous request to the same endpo...

List the people ``username`` follows. :param str username: (required), login of the user :param int number: (optional), number of users being followed by username to return. Default: -1, return all of them :param str etag: (optional), ETag from a previous request to the same endpoint :r...

List issues on owner/repository. Only owner and repository are required. .. versionchanged:: 0.9.0 - The ``state`` parameter now accepts 'all' in addition to 'open' and 'closed'. :param str owner: login of the owner of the repository :param str repository: name of the repository ...

List the organizations associated with ``username``. :param str username: (required), login of the user :param int number: (optional), number of orgs to return. Default: -1, return all of the issues :param str etag: (optional), ETag from a previous request to the same endpoint :returns:...

List public repositories for the specified ``login``. .. versionadded:: 0.6 .. note:: This replaces github3.iter_repos :param str login: (required) :param str type: (optional), accepted values: ('all', 'owner', 'member') API default: 'all' :param str sort: (optional), accepted val...