desc
stringlengths
3
26.7k
decl
stringlengths
11
7.89k
bodies
stringlengths
8
553k
':type: string'
@property def email(self):
self._completeIfNotSet(self._email) return self._email.value
':type: string'
@property def events_url(self):
self._completeIfNotSet(self._events_url) return self._events_url.value
':type: integer'
@property def followers(self):
self._completeIfNotSet(self._followers) return self._followers.value
':type: string'
@property def followers_url(self):
self._completeIfNotSet(self._followers_url) return self._followers_url.value
':type: integer'
@property def following(self):
self._completeIfNotSet(self._following) return self._following.value
':type: string'
@property def following_url(self):
self._completeIfNotSet(self._following_url) return self._following_url.value
':type: string'
@property def gists_url(self):
self._completeIfNotSet(self._gists_url) return self._gists_url.value
':type: string'
@property def gravatar_id(self):
self._completeIfNotSet(self._gravatar_id) return self._gravatar_id.value
':type: bool'
@property def hireable(self):
self._completeIfNotSet(self._hireable) return self._hireable.value
':type: string'
@property def html_url(self):
self._completeIfNotSet(self._html_url) return self._html_url.value
':type: integer'
@property def id(self):
self._completeIfNotSet(self._id) return self._id.value
':type: string'
@property def location(self):
self._completeIfNotSet(self._location) return self._location.value
':type: string'
@property def login(self):
self._completeIfNotSet(self._login) return self._login.value
':type: string'
@property def name(self):
self._completeIfNotSet(self._name) return self._name.value
':type: string'
@property def organizations_url(self):
self._completeIfNotSet(self._organizations_url) return self._organizations_url.value
':type: integer'
@property def owned_private_repos(self):
self._completeIfNotSet(self._owned_private_repos) return self._owned_private_repos.value
':type: :class:`github.Plan.Plan`'
@property def plan(self):
self._completeIfNotSet(self._plan) return self._plan.value
':type: integer'
@property def private_gists(self):
self._completeIfNotSet(self._private_gists) return self._private_gists.value
':type: integer'
@property def public_gists(self):
self._completeIfNotSet(self._public_gists) return self._public_gists.value
':type: integer'
@property def public_repos(self):
self._completeIfNotSet(self._public_repos) return self._public_repos.value
':type: string'
@property def received_events_url(self):
self._completeIfNotSet(self._received_events_url) return self._received_events_url.value
':type: string'
@property def repos_url(self):
self._completeIfNotSet(self._repos_url) return self._repos_url.value
':type: bool'
@property def site_admin(self):
self._completeIfNotSet(self._site_admin) return self._site_admin.value
':type: string'
@property def starred_url(self):
self._completeIfNotSet(self._starred_url) return self._starred_url.value
':type: string'
@property def subscriptions_url(self):
self._completeIfNotSet(self._subscriptions_url) return self._subscriptions_url.value
':type: integer'
@property def total_private_repos(self):
self._completeIfNotSet(self._total_private_repos) return self._total_private_repos.value
':type: string'
@property def type(self):
self._completeIfNotSet(self._type) return self._type.value
':type: datetime.datetime'
@property def updated_at(self):
self._completeIfNotSet(self._updated_at) return self._updated_at.value
':type: string'
@property def url(self):
self._completeIfNotSet(self._url) return self._url.value
':calls: `POST /user/emails <http://developer.github.com/v3/users/emails>`_ :param email: string :rtype: None'
def add_to_emails(self, *emails):
assert all((isinstance(element, (str, unicode)) for element in emails)), emails post_parameters = emails (headers, data) = self._requester.requestJsonAndCheck('POST', '/user/emails', input=post_parameters)
':calls: `PUT /user/following/:user <http://developer.github.com/v3/users/followers>`_ :param following: :class:`github.NamedUser.NamedUser` :rtype: None'
def add_to_following(self, following):
assert isinstance(following, github.NamedUser.NamedUser), following (headers, data) = self._requester.requestJsonAndCheck('PUT', ('/user/following/' + following._identity))
':calls: `PUT /user/starred/:owner/:repo <http://developer.github.com/v3/activity/starring>`_ :param starred: :class:`github.Repository.Repository` :rtype: None'
def add_to_starred(self, starred):
assert isinstance(starred, github.Repository.Repository), starred (headers, data) = self._requester.requestJsonAndCheck('PUT', ('/user/starred/' + starred._identity))
':calls: `PUT /user/subscriptions/:owner/:repo <http://developer.github.com/v3/activity/watching>`_ :param subscription: :class:`github.Repository.Repository` :rtype: None'
def add_to_subscriptions(self, subscription):
assert isinstance(subscription, github.Repository.Repository), subscription (headers, data) = self._requester.requestJsonAndCheck('PUT', ('/user/subscriptions/' + subscription._identity))
':calls: `PUT /user/watched/:owner/:repo <http://developer.github.com/v3/activity/starring>`_ :param watched: :class:`github.Repository.Repository` :rtype: None'
def add_to_watched(self, watched):
assert isinstance(watched, github.Repository.Repository), watched (headers, data) = self._requester.requestJsonAndCheck('PUT', ('/user/watched/' + watched._identity))
':calls: `POST /authorizations <http://developer.github.com/v3/oauth>`_ :param scopes: list of string :param note: string :param note_url: string :param client_id: string :param client_secret: string :param onetime_password: string :rtype: :class:`github.Authorization.Authorization`'
def create_authorization(self, scopes=github.GithubObject.NotSet, note=github.GithubObject.NotSet, note_url=github.GithubObject.NotSet, client_id=github.GithubObject.NotSet, client_secret=github.GithubObject.NotSet, onetime_password=None):
assert ((scopes is github.GithubObject.NotSet) or all((isinstance(element, (str, unicode)) for element in scopes))), scopes assert ((note is github.GithubObject.NotSet) or isinstance(note, (str, unicode))), note assert ((note_url is github.GithubObject.NotSet) or isinstance(note_url, (str, unicode))), note_...
':calls: `POST /repos/:owner/:repo/forks <http://developer.github.com/v3/repos/forks>`_ :param repo: :class:`github.Repository.Repository` :rtype: :class:`github.Repository.Repository`'
def create_fork(self, repo):
assert isinstance(repo, github.Repository.Repository), repo (headers, data) = self._requester.requestJsonAndCheck('POST', (((('/repos/' + repo.owner.login) + '/') + repo.name) + '/forks')) return github.Repository.Repository(self._requester, headers, data, completed=True)
':calls: `POST /gists <http://developer.github.com/v3/gists>`_ :param public: bool :param files: dict of string to :class:`github.InputFileContent.InputFileContent` :param description: string :rtype: :class:`github.Gist.Gist`'
def create_gist(self, public, files, description=github.GithubObject.NotSet):
assert isinstance(public, bool), public assert all((isinstance(element, github.InputFileContent) for element in files.itervalues())), files assert ((description is github.GithubObject.NotSet) or isinstance(description, (str, unicode))), description post_parameters = {'public': public, 'files': dict(((ke...
':calls: `POST /user/keys <http://developer.github.com/v3/users/keys>`_ :param title: string :param key: string :rtype: :class:`github.UserKey.UserKey`'
def create_key(self, title, key):
assert isinstance(title, (str, unicode)), title assert isinstance(key, (str, unicode)), key post_parameters = {'title': title, 'key': key} (headers, data) = self._requester.requestJsonAndCheck('POST', '/user/keys', input=post_parameters) return github.UserKey.UserKey(self._requester, headers, data, ...
':calls: `POST /user/repos <http://developer.github.com/v3/repos>`_ :param name: string :param description: string :param homepage: string :param private: bool :param has_issues: bool :param has_wiki: bool :param has_downloads: bool :param auto_init: bool :param gitignore_template: string :rtype: :class:`github.Reposit...
def create_repo(self, name, description=github.GithubObject.NotSet, homepage=github.GithubObject.NotSet, private=github.GithubObject.NotSet, has_issues=github.GithubObject.NotSet, has_wiki=github.GithubObject.NotSet, has_downloads=github.GithubObject.NotSet, auto_init=github.GithubObject.NotSet, gitignore_template=gith...
assert isinstance(name, (str, unicode)), name assert ((description is github.GithubObject.NotSet) or isinstance(description, (str, unicode))), description assert ((homepage is github.GithubObject.NotSet) or isinstance(homepage, (str, unicode))), homepage assert ((private is github.GithubObject.NotSet) o...
':calls: `PATCH /user <http://developer.github.com/v3/users>`_ :param name: string :param email: string :param blog: string :param company: string :param location: string :param hireable: bool :param bio: string :rtype: None'
def edit(self, name=github.GithubObject.NotSet, email=github.GithubObject.NotSet, blog=github.GithubObject.NotSet, company=github.GithubObject.NotSet, location=github.GithubObject.NotSet, hireable=github.GithubObject.NotSet, bio=github.GithubObject.NotSet):
assert ((name is github.GithubObject.NotSet) or isinstance(name, (str, unicode))), name assert ((email is github.GithubObject.NotSet) or isinstance(email, (str, unicode))), email assert ((blog is github.GithubObject.NotSet) or isinstance(blog, (str, unicode))), blog assert ((company is github.GithubObje...
':calls: `GET /authorizations/:id <http://developer.github.com/v3/oauth>`_ :param id: integer :rtype: :class:`github.Authorization.Authorization`'
def get_authorization(self, id):
assert isinstance(id, (int, long)), id (headers, data) = self._requester.requestJsonAndCheck('GET', ('/authorizations/' + str(id))) return github.Authorization.Authorization(self._requester, headers, data, completed=True)
':calls: `GET /authorizations <http://developer.github.com/v3/oauth>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Authorization.Authorization`'
def get_authorizations(self):
return github.PaginatedList.PaginatedList(github.Authorization.Authorization, self._requester, '/authorizations', None)
':calls: `GET /user/emails <http://developer.github.com/v3/users/emails>`_ :rtype: list of string'
def get_emails(self):
(headers, data) = self._requester.requestJsonAndCheck('GET', '/user/emails') return data
':calls: `GET /events <http://developer.github.com/v3/activity/events>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Event.Event`'
def get_events(self):
return github.PaginatedList.PaginatedList(github.Event.Event, self._requester, '/events', None)
':calls: `GET /user/followers <http://developer.github.com/v3/users/followers>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.NamedUser.NamedUser`'
def get_followers(self):
return github.PaginatedList.PaginatedList(github.NamedUser.NamedUser, self._requester, '/user/followers', None)
':calls: `GET /user/following <http://developer.github.com/v3/users/followers>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.NamedUser.NamedUser`'
def get_following(self):
return github.PaginatedList.PaginatedList(github.NamedUser.NamedUser, self._requester, '/user/following', None)
':calls: `GET /gists <http://developer.github.com/v3/gists>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Gist.Gist`'
def get_gists(self):
return github.PaginatedList.PaginatedList(github.Gist.Gist, self._requester, '/gists', None)
':calls: `GET /issues <http://developer.github.com/v3/issues>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Issue.Issue` :param filter: string :param state: string :param labels: list of :class:`github.Label.Label` :param sort: string :param direction: string :param since: datetime.datetime :r...
def get_issues(self, filter=github.GithubObject.NotSet, state=github.GithubObject.NotSet, labels=github.GithubObject.NotSet, sort=github.GithubObject.NotSet, direction=github.GithubObject.NotSet, since=github.GithubObject.NotSet):
assert ((filter is github.GithubObject.NotSet) or isinstance(filter, (str, unicode))), filter assert ((state is github.GithubObject.NotSet) or isinstance(state, (str, unicode))), state assert ((labels is github.GithubObject.NotSet) or all((isinstance(element, github.Label.Label) for element in labels))), la...
':calls: `GET /user/issues <http://developer.github.com/v3/issues>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Issue.Issue` :param filter: string :param state: string :param labels: list of :class:`github.Label.Label` :param sort: string :param direction: string :param since: datetime.dateti...
def get_user_issues(self, filter=github.GithubObject.NotSet, state=github.GithubObject.NotSet, labels=github.GithubObject.NotSet, sort=github.GithubObject.NotSet, direction=github.GithubObject.NotSet, since=github.GithubObject.NotSet):
assert ((filter is github.GithubObject.NotSet) or isinstance(filter, (str, unicode))), filter assert ((state is github.GithubObject.NotSet) or isinstance(state, (str, unicode))), state assert ((labels is github.GithubObject.NotSet) or all((isinstance(element, github.Label.Label) for element in labels))), la...
':calls: `GET /user/keys/:id <http://developer.github.com/v3/users/keys>`_ :param id: integer :rtype: :class:`github.UserKey.UserKey`'
def get_key(self, id):
assert isinstance(id, (int, long)), id (headers, data) = self._requester.requestJsonAndCheck('GET', ('/user/keys/' + str(id))) return github.UserKey.UserKey(self._requester, headers, data, completed=True)
':calls: `GET /user/keys <http://developer.github.com/v3/users/keys>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.UserKey.UserKey`'
def get_keys(self):
return github.PaginatedList.PaginatedList(github.UserKey.UserKey, self._requester, '/user/keys', None)
':calls: `GET /notifications/threads/:id <http://developer.github.com/v3/activity/notifications>`_ :rtype: :class:`github.Notification.Notification`'
def get_notification(self, id):
assert isinstance(id, (str, unicode)), id (headers, data) = self._requester.requestJsonAndCheck('GET', ('/notifications/threads/' + id)) return github.Notification.Notification(self._requester, headers, data, completed=True)
':calls: `GET /notifications <http://developer.github.com/v3/activity/notifications>`_ :param all: bool :param participating: bool :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Notification.Notification`'
def get_notifications(self, all=github.GithubObject.NotSet, participating=github.GithubObject.NotSet):
assert ((all is github.GithubObject.NotSet) or isinstance(all, bool)), all assert ((participating is github.GithubObject.NotSet) or isinstance(participating, bool)), participating params = dict() if (all is not github.GithubObject.NotSet): params['all'] = all if (participating is not github....
':calls: `GET /users/:user/events/orgs/:org <http://developer.github.com/v3/activity/events>`_ :param org: :class:`github.Organization.Organization` :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Event.Event`'
def get_organization_events(self, org):
assert isinstance(org, github.Organization.Organization), org return github.PaginatedList.PaginatedList(github.Event.Event, self._requester, ((('/users/' + self.login) + '/events/orgs/') + org.login), None)
':calls: `GET /user/orgs <http://developer.github.com/v3/orgs>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Organization.Organization`'
def get_orgs(self):
return github.PaginatedList.PaginatedList(github.Organization.Organization, self._requester, '/user/orgs', None)
':calls: `GET /repos/:owner/:repo <http://developer.github.com/v3/repos>`_ :param name: string :rtype: :class:`github.Repository.Repository`'
def get_repo(self, name):
assert isinstance(name, (str, unicode)), name (headers, data) = self._requester.requestJsonAndCheck('GET', ((('/repos/' + self.login) + '/') + name)) return github.Repository.Repository(self._requester, headers, data, completed=True)
':calls: `GET /user/repos <http://developer.github.com/v3/repos>`_ :param type: string :param sort: string :param direction: string :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Repository.Repository`'
def get_repos(self, type=github.GithubObject.NotSet, sort=github.GithubObject.NotSet, direction=github.GithubObject.NotSet):
assert ((type is github.GithubObject.NotSet) or isinstance(type, (str, unicode))), type assert ((sort is github.GithubObject.NotSet) or isinstance(sort, (str, unicode))), sort assert ((direction is github.GithubObject.NotSet) or isinstance(direction, (str, unicode))), direction url_parameters = dict() ...
':calls: `GET /user/starred <http://developer.github.com/v3/activity/starring>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Repository.Repository`'
def get_starred(self):
return github.PaginatedList.PaginatedList(github.Repository.Repository, self._requester, '/user/starred', None)
':calls: `GET /gists/starred <http://developer.github.com/v3/gists>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Gist.Gist`'
def get_starred_gists(self):
return github.PaginatedList.PaginatedList(github.Gist.Gist, self._requester, '/gists/starred', None)
':calls: `GET /user/subscriptions <http://developer.github.com/v3/activity/watching>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Repository.Repository`'
def get_subscriptions(self):
return github.PaginatedList.PaginatedList(github.Repository.Repository, self._requester, '/user/subscriptions', None)
':calls: `GET /user/teams <http://developer.github.com/v3/orgs/teams>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Team.Team`'
def get_teams(self):
return github.PaginatedList.PaginatedList(github.Team.Team, self._requester, '/user/teams', None)
':calls: `GET /user/watched <http://developer.github.com/v3/activity/starring>`_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Repository.Repository`'
def get_watched(self):
return github.PaginatedList.PaginatedList(github.Repository.Repository, self._requester, '/user/watched', None)
':calls: `GET /user/following/:user <http://developer.github.com/v3/users/followers>`_ :param following: :class:`github.NamedUser.NamedUser` :rtype: bool'
def has_in_following(self, following):
assert isinstance(following, github.NamedUser.NamedUser), following (status, headers, data) = self._requester.requestJson('GET', ('/user/following/' + following._identity)) return (status == 204)
':calls: `GET /user/starred/:owner/:repo <http://developer.github.com/v3/activity/starring>`_ :param starred: :class:`github.Repository.Repository` :rtype: bool'
def has_in_starred(self, starred):
assert isinstance(starred, github.Repository.Repository), starred (status, headers, data) = self._requester.requestJson('GET', ('/user/starred/' + starred._identity)) return (status == 204)
':calls: `GET /user/subscriptions/:owner/:repo <http://developer.github.com/v3/activity/watching>`_ :param subscription: :class:`github.Repository.Repository` :rtype: bool'
def has_in_subscriptions(self, subscription):
assert isinstance(subscription, github.Repository.Repository), subscription (status, headers, data) = self._requester.requestJson('GET', ('/user/subscriptions/' + subscription._identity)) return (status == 204)
':calls: `GET /user/watched/:owner/:repo <http://developer.github.com/v3/activity/starring>`_ :param watched: :class:`github.Repository.Repository` :rtype: bool'
def has_in_watched(self, watched):
assert isinstance(watched, github.Repository.Repository), watched (status, headers, data) = self._requester.requestJson('GET', ('/user/watched/' + watched._identity)) return (status == 204)
':calls: `DELETE /user/emails <http://developer.github.com/v3/users/emails>`_ :param email: string :rtype: None'
def remove_from_emails(self, *emails):
assert all((isinstance(element, (str, unicode)) for element in emails)), emails post_parameters = emails (headers, data) = self._requester.requestJsonAndCheck('DELETE', '/user/emails', input=post_parameters)
':calls: `DELETE /user/following/:user <http://developer.github.com/v3/users/followers>`_ :param following: :class:`github.NamedUser.NamedUser` :rtype: None'
def remove_from_following(self, following):
assert isinstance(following, github.NamedUser.NamedUser), following (headers, data) = self._requester.requestJsonAndCheck('DELETE', ('/user/following/' + following._identity))
':calls: `DELETE /user/starred/:owner/:repo <http://developer.github.com/v3/activity/starring>`_ :param starred: :class:`github.Repository.Repository` :rtype: None'
def remove_from_starred(self, starred):
assert isinstance(starred, github.Repository.Repository), starred (headers, data) = self._requester.requestJsonAndCheck('DELETE', ('/user/starred/' + starred._identity))
':calls: `DELETE /user/subscriptions/:owner/:repo <http://developer.github.com/v3/activity/watching>`_ :param subscription: :class:`github.Repository.Repository` :rtype: None'
def remove_from_subscriptions(self, subscription):
assert isinstance(subscription, github.Repository.Repository), subscription (headers, data) = self._requester.requestJsonAndCheck('DELETE', ('/user/subscriptions/' + subscription._identity))
':calls: `DELETE /user/watched/:owner/:repo <http://developer.github.com/v3/activity/starring>`_ :param watched: :class:`github.Repository.Repository` :rtype: None'
def remove_from_watched(self, watched):
assert isinstance(watched, github.Repository.Repository), watched (headers, data) = self._requester.requestJsonAndCheck('DELETE', ('/user/watched/' + watched._identity))
':type: :class:`github.NamedUser.NamedUser`'
@property def actor(self):
self._completeIfNotSet(self._actor) return self._actor.value
':type: string'
@property def commit_id(self):
self._completeIfNotSet(self._commit_id) return self._commit_id.value
':type: datetime.datetime'
@property def created_at(self):
self._completeIfNotSet(self._created_at) return self._created_at.value
':type: string'
@property def event(self):
self._completeIfNotSet(self._event) return self._event.value
':type: integer'
@property def id(self):
self._completeIfNotSet(self._id) return self._id.value
':type: :class:`github.Issue.Issue`'
@property def issue(self):
self._completeIfNotSet(self._issue) return self._issue.value
':type: string'
@property def url(self):
self._completeIfNotSet(self._url) return self._url.value
':type: string'
@property def color(self):
self._completeIfNotSet(self._color) return self._color.value
':type: string'
@property def name(self):
self._completeIfNotSet(self._name) return self._name.value
':type: string'
@property def url(self):
self._completeIfNotSet(self._url) return self._url.value
':calls: `DELETE /repos/:owner/:repo/labels/:name <http://developer.github.com/v3/issues/labels>`_ :rtype: None'
def delete(self):
(headers, data) = self._requester.requestJsonAndCheck('DELETE', self.url)
':calls: `PATCH /repos/:owner/:repo/labels/:name <http://developer.github.com/v3/issues/labels>`_ :param name: string :param color: string :rtype: None'
def edit(self, name, color):
assert isinstance(name, (str, unicode)), name assert isinstance(color, (str, unicode)), color post_parameters = {'name': name, 'color': color} (headers, data) = self._requester.requestJsonAndCheck('PATCH', self.url, input=post_parameters) self._useAttributes(data)
':type: bool'
@property def merged(self):
return self._merged.value
':type: string'
@property def message(self):
return self._message.value
':type: string'
@property def sha(self):
return self._sha.value
':type: string'
@property def accesskeyid(self):
self._completeIfNotSet(self._accesskeyid) return self._accesskeyid.value
':type: string'
@property def acl(self):
self._completeIfNotSet(self._acl) return self._acl.value
':type: string'
@property def bucket(self):
self._completeIfNotSet(self._bucket) return self._bucket.value
':type: string'
@property def content_type(self):
self._completeIfNotSet(self._content_type) return self._content_type.value
':type: datetime.datetime'
@property def created_at(self):
self._completeIfNotSet(self._created_at) return self._created_at.value
':type: string'
@property def description(self):
self._completeIfNotSet(self._description) return self._description.value
':type: integer'
@property def download_count(self):
self._completeIfNotSet(self._download_count) return self._download_count.value
':type: datetime.datetime'
@property def expirationdate(self):
self._completeIfNotSet(self._expirationdate) return self._expirationdate.value
':type: string'
@property def html_url(self):
self._completeIfNotSet(self._html_url) return self._html_url.value
':type: integer'
@property def id(self):
self._completeIfNotSet(self._id) return self._id.value
':type: string'
@property def mime_type(self):
self._completeIfNotSet(self._mime_type) return self._mime_type.value
':type: string'
@property def name(self):
self._completeIfNotSet(self._name) return self._name.value
':type: string'
@property def path(self):
self._completeIfNotSet(self._path) return self._path.value
':type: string'
@property def policy(self):
self._completeIfNotSet(self._policy) return self._policy.value