diff options
author | 2012-03-01 13:12:00 +0100 | |
---|---|---|
committer | 2012-03-01 13:12:00 +0100 | |
commit | 397238b404a66ba25aec1e4d7902e16104eddefc (patch) | |
tree | 7453341e1e3257282cf5d87285b451b6fc13ec23 /pygithub3/services | |
parent | Services.repos.Repo doc (diff) | |
download | python-github3-397238b404a66ba25aec1e4d7902e16104eddefc.tar.xz python-github3-397238b404a66ba25aec1e4d7902e16104eddefc.zip |
Restructure modules and packages in a clean way
The docs has increased lines of code, so I split it
Diffstat (limited to 'pygithub3/services')
-rw-r--r-- | pygithub3/services/base.py | 2 | ||||
-rw-r--r-- | pygithub3/services/repos.py | 360 | ||||
-rw-r--r-- | pygithub3/services/repos/__init__.py | 199 | ||||
-rw-r--r-- | pygithub3/services/repos/collaborators.py | 27 | ||||
-rw-r--r-- | pygithub3/services/repos/commits.py | 48 | ||||
-rw-r--r-- | pygithub3/services/repos/downloads.py | 38 | ||||
-rw-r--r-- | pygithub3/services/repos/forks.py | 17 | ||||
-rw-r--r-- | pygithub3/services/repos/keys.py | 31 | ||||
-rw-r--r-- | pygithub3/services/repos/watchers.py | 31 | ||||
-rw-r--r-- | pygithub3/services/users.py | 233 | ||||
-rw-r--r-- | pygithub3/services/users/__init__.py | 49 | ||||
-rw-r--r-- | pygithub3/services/users/emails.py | 49 | ||||
-rw-r--r-- | pygithub3/services/users/followers.py | 84 | ||||
-rw-r--r-- | pygithub3/services/users/keys.py | 66 |
14 files changed, 640 insertions, 594 deletions
diff --git a/pygithub3/services/base.py b/pygithub3/services/base.py index d50ceb7..7fb6133 100644 --- a/pygithub3/services/base.py +++ b/pygithub3/services/base.py @@ -3,7 +3,7 @@ from pygithub3.core.client import Client from pygithub3.core.result import Result -from pygithub3.requests import Factory +from pygithub3.requests.base import Factory from pygithub3.core.errors import NotFound diff --git a/pygithub3/services/repos.py b/pygithub3/services/repos.py deleted file mode 100644 index b4cf43c..0000000 --- a/pygithub3/services/repos.py +++ /dev/null @@ -1,360 +0,0 @@ -#!/usr/bin/env python -# -*- encoding: utf-8 -*- - -import requests - -from .base import Service, MimeTypeMixin - - -class Watchers(Service): - - def list(self, user=None, repo=None): - request = self.make_request('repos.watchers.list', - user=user, repo=repo) - return self._get_result(request) - - def list_repos(self, user=None): - request = self.make_request('repos.watchers.list_repos', user=user) - return self._get_result(request) - - def is_watching(self, user=None, repo=None): - request = self.make_request('repos.watchers.is_watching', - user=user, repo=repo) - return self._bool(request) - - def watch(self, user=None, repo=None): - request = self.make_request('repos.watchers.watch', - user=user, repo=repo) - self._put(request) - - def unwatch(self, user=None, repo=None): - request = self.make_request('repos.watchers.unwatch', - user=user, repo=repo) - self._delete(request) - - -class Keys(Service): - - def list(self, user=None, repo=None): - request = self.make_request('repos.keys.list', user=user, repo=repo) - return self._get_result(request) - - def get(self, id, user=None, repo=None): - request = self.make_request('repos.keys.get', - id=id, user=user, repo=repo) - return self._get(request) - - def create(self, data, user=None, repo=None): - request = self.make_request('repos.keys.create', - body=data, user=user, repo=repo) - return self._post(request) - - def update(self, id, data, user=None, repo=None): - request = self.make_request('repos.keys.update', - id=id, body=data, user=user, repo=repo) - return self._patch(request) - - def delete(self, id, user=None, repo=None): - request = self.make_request('repos.keys.delete', - id=id, user=user, repo=repo) - self._delete(request) - - -class Forks(Service): - - def list(self, user=None, repo=None, sort='newest'): - request = self.make_request('repos.forks.list', user=user, repo=repo) - return self._get_result(request, sort=sort) - - def create(self, user=None, repo=None, org=None): - request = self.make_request('repos.forks.create', user=user, repo=repo) - org = {'org': org} if org else {} - return self._post(request, **org) - - -class Downloads(Service): - - def list(self, user=None, repo=None): - request = self.make_request('repos.downloads.list', - user=user, repo=repo) - return self._get_result(request) - - def get(self, id, user=None, repo=None): - request = self.make_request('repos.downloads.get', - id=id, user=user, repo=repo) - return self._get(request) - - def create(self, data, user=None, repo=None): - request = self.make_request('repos.downloads.create', - body=data, user=user, repo=repo) - download = self._post(request) - - # TODO: improve it. e.g Manage all with file desc - def upload(file_path): - body = download.ball_to_upload() - body['file'] = (file_path, open(file_path, 'rb')) - return requests.post(download.s3_url, files=body) - - download.upload = upload - return download - - def delete(self, id=id, user=None, repo=None): - request = self.make_request('repos.downloads.delete', - id=id, user=user, repo=repo) - self._delete(request) - - -class Commits(Service, MimeTypeMixin): - - """ TODO: Pagination structure differs from usual - def list(self, user=None, repo=None, sha='', path=''): - request = self.make_request('repos.commits.list', user=user, repo=repo) - return self._get_result(request, sha=sha, path=path) - """ - - def get(self, sha, user=None, repo=None): - request = self.make_request('repos.commits.get', - sha=sha, user=user, repo=repo) - return self._get(request) - - def list_comments(self, sha=None, user=None, repo=None): - request = self.make_request('repos.commits.list_comments', - sha=sha, user=user, repo=repo) - return self._get_result(request, **self._get_mimetype_as_header()) - - def create_comment(self, data, sha, user=None, repo=None): - request = self.make_request('repos.commits.create_comment', - sha=sha, user=user, repo=repo, body=data) - return self._post(request, **self._get_mimetype_as_header()) - - def get_comment(self, cid, user=None, repo=None): - request = self.make_request('repos.commits.get_comment', - comment_id=cid, user=user, repo=repo) - return self._get(request, **self._get_mimetype_as_header()) - - def update_comment(self, data, cid, user=None, repo=None): - request = self.make_request('repos.commits.update_comment', - comment_id=cid, user=user, repo=repo, body=data) - return self._patch(request, **self._get_mimetype_as_header()) - - def compare(self, base, head, user=None, repo=None): - request = self.make_request('repos.commits.compare', - base=base, head=head, user=user, repo=repo) - return self._get(request) - - def delete_comment(self, cid, user=None, repo=None): - request = self.make_request('repos.commits.delete_comment', - comment_id=cid, user=user, repo=repo) - self._delete(request) - - -class Collaborators(Service): - - def list(self, user=None, repo=None): - request = self.make_request('repos.collaborators.list', - user=user, repo=repo) - return self._get_result(request) - - def add(self, collaborator, user=None, repo=None): - request = self.make_request('repos.collaborators.add', - collaborator=collaborator, user=user, repo=repo) - return self._put(request) - - def is_collaborator(self, collaborator, user=None, repo=None): - request = self.make_request('repos.collaborators.is_collaborator', - collaborator=collaborator, user=user, repo=repo) - return self._bool(request) - - def delete(self, collaborator, user=None, repo=None): - request = self.make_request('repos.collaborators.delete', - collaborator=collaborator, user=user, repo=repo) - self._delete(request) - - -class Repo(Service): - """ Consume `Repos API <http://developer.github.com/v3/repos>`_ """ - - def __init__(self, **config): - self.collaborators = Collaborators(**config) - self.commits = Commits(**config) - self.downloads = Downloads(**config) - self.forks = Forks(**config) - self.keys = Keys(**config) - self.watchers = Watchers(**config) - super(Repo, self).__init__(**config) - - def list(self, user=None, type='all'): - """ Get user's repositories - - :param str user: Username - :param str type: Filter by type (optional). See `github repo doc`_ - :returns: A :doc:`result` - - If you call it without user and you are authenticated, get the - authenticated user's repositories - - .. warning:: - - If you aren't authenticated and call without user, it returns 403 - - :: - - repo_service.list('copitux', type='owner') - repo_service.list(type='private') - """ - request = self.make_request('repos.list', user=user) - return self._get_result(request, type=type) - - def list_by_org(self, org, type='all'): - """ Get organization's repositories - - :param str org: Organization name - :param str type: Filter by type (optional). See `github repo doc`_ - :returns: A :doc:`result` - - :: - - repo_service.list_by_org('myorganization', type='member') - """ - request = self.make_request('repos.list_by_org', org=org) - return self._get_result(request, type=type) - - def create(self, data, in_org=None): - """ Create a new repository - - :param dict data: Input. See `github repo doc`_ - :param str in_org: Organization where create the repository (optional) - - .. warning:: - - You must be authenticated - - If you use ``in_org`` arg, the authenticated user must be a member - of <in_org> - - :: - - repo_service.create(dict(name='new_repo', description='desc')) - repo_service.create(dict(name='new_repo_in_org', team_id=2300), - in_org='myorganization') - """ - request = self.make_request('repos.create', org=in_org, body=data) - return self._post(request) - - def get(self, user=None, repo=None): - """ Get a single repo - - :param str user: Username - :param str repo: Repository - - .. note:: - - Remember :ref:`config precedence` - """ - request = self.make_request('repos.get', user=user, repo=repo) - return self._get(request) - - def update(self, data, user=None, repo=None): - """ Update a single repository - - :param dict data: Input. See `github repo doc`_ - :param str user: Username - :param str repo: Repository - - .. note:: - - Remember :ref:`config precedence` - - .. warning:: - - You must be authenticated - - :: - - repo_service.update(dict(has_issues=True), user='octocat', - repo='oct_repo') - """ - request = self.make_request('repos.update', body=data, - user=user, repo=repo) - return self._patch(request) - - def __list_contributors(self, user=None, repo=None, **kwargs): - request = self.make_request('repos.list_contributors', - user=user, repo=repo) - return self._get_result(request, **kwargs) - - def list_contributors(self, user=None, repo=None): - """ Get repository's contributors - - :param str user: Username - :param str repo: Repository - :returns: A :doc:`result` - - .. note:: - - Remember :ref:`config precedence` - """ - return self.__list_contributors(user, repo) - - def list_contributors_with_anonymous(self, user=None, repo=None): - """ Like :attr:`~pygithub3.services.repos.Repo.list_contributors` plus - anonymous """ - return self.__list_contributors(user, repo, anom=True) - - def list_languages(self, user=None, repo=None): - """ Get repository's languages - - :param str user: Username - :param str repo: Repository - :returns: A :doc:`result` - - .. note:: - - Remember :ref:`config precedence` - """ - request = self.make_request('repos.list_languages', - user=user, repo=repo) - return self._get(request) - - def list_teams(self, user=None, repo=None): - """ Get repository's teams - - :param str user: Username - :param str repo: Repository - :returns: A :doc:`result` - - .. note:: - - Remember :ref:`config precedence` - """ - request = self.make_request('repos.list_teams', user=user, repo=repo) - return self._get_result(request) - - def list_tags(self, user=None, repo=None): - """ Get repository's tags - - :param str user: Username - :param str repo: Repository - :returns: A :doc:`result` - - .. note:: - - Remember :ref:`config precedence` - """ - request = self.make_request('repos.list_tags', user=user, repo=repo) - return self._get_result(request) - - def list_branches(self, user=None, repo=None): - """ Get repository's branches - - :param str user: Username - :param str repo: Repository - :returns: A :doc:`result` - - .. note:: - - Remember :ref:`config precedence` - """ - request = self.make_request('repos.list_branches', - user=user, repo=repo) - return self._get_result(request) diff --git a/pygithub3/services/repos/__init__.py b/pygithub3/services/repos/__init__.py new file mode 100644 index 0000000..6e3627f --- /dev/null +++ b/pygithub3/services/repos/__init__.py @@ -0,0 +1,199 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from ..base import Service, MimeTypeMixin +from .collaborators import Collaborators +from .commits import Commits +from .downloads import Downloads +from .forks import Forks +from .keys import Keys +from .watchers import Watchers + + +class Repos(Service): + """ Consume `Repos API <http://developer.github.com/v3/repos>`_ """ + + def __init__(self, **config): + self.collaborators = Collaborators(**config) + self.commits = Commits(**config) + self.downloads = Downloads(**config) + self.forks = Forks(**config) + self.keys = Keys(**config) + self.watchers = Watchers(**config) + super(Repos, self).__init__(**config) + + def list(self, user=None, type='all'): + """ Get user's repositories + + :param str user: Username + :param str type: Filter by type (optional). See `github repo doc`_ + :returns: A :doc:`result` + + If you call it without user and you are authenticated, get the + authenticated user's repositories + + .. warning:: + + If you aren't authenticated and call without user, it returns 403 + + :: + + repo_service.list('copitux', type='owner') + repo_service.list(type='private') + """ + request = self.make_request('repos.list', user=user) + return self._get_result(request, type=type) + + def list_by_org(self, org, type='all'): + """ Get organization's repositories + + :param str org: Organization name + :param str type: Filter by type (optional). See `github repo doc`_ + :returns: A :doc:`result` + + :: + + repo_service.list_by_org('myorganization', type='member') + """ + request = self.make_request('repos.list_by_org', org=org) + return self._get_result(request, type=type) + + def create(self, data, in_org=None): + """ Create a new repository + + :param dict data: Input. See `github repo doc`_ + :param str in_org: Organization where create the repository (optional) + + .. warning:: + + You must be authenticated + + If you use ``in_org`` arg, the authenticated user must be a member + of <in_org> + + :: + + repo_service.create(dict(name='new_repo', description='desc')) + repo_service.create(dict(name='new_repo_in_org', team_id=2300), + in_org='myorganization') + """ + request = self.make_request('repos.create', org=in_org, body=data) + return self._post(request) + + def get(self, user=None, repo=None): + """ Get a single repo + + :param str user: Username + :param str repo: Repository + + .. note:: + + Remember :ref:`config precedence` + """ + request = self.make_request('repos.get', user=user, repo=repo) + return self._get(request) + + def update(self, data, user=None, repo=None): + """ Update a single repository + + :param dict data: Input. See `github repo doc`_ + :param str user: Username + :param str repo: Repository + + .. note:: + + Remember :ref:`config precedence` + + .. warning:: + + You must be authenticated + + :: + + repo_service.update(dict(has_issues=True), user='octocat', + repo='oct_repo') + """ + request = self.make_request('repos.update', body=data, + user=user, repo=repo) + return self._patch(request) + + def __list_contributors(self, user=None, repo=None, **kwargs): + request = self.make_request('repos.list_contributors', + user=user, repo=repo) + return self._get_result(request, **kwargs) + + def list_contributors(self, user=None, repo=None): + """ Get repository's contributors + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + + Remember :ref:`config precedence` + """ + return self.__list_contributors(user, repo) + + def list_contributors_with_anonymous(self, user=None, repo=None): + """ Like :attr:`~pygithub3.services.repos.Repos.list_contributors` plus + anonymous """ + return self.__list_contributors(user, repo, anom=True) + + def list_languages(self, user=None, repo=None): + """ Get repository's languages + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + + Remember :ref:`config precedence` + """ + request = self.make_request('repos.list_languages', + user=user, repo=repo) + return self._get(request) + + def list_teams(self, user=None, repo=None): + """ Get repository's teams + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + + Remember :ref:`config precedence` + """ + request = self.make_request('repos.list_teams', user=user, repo=repo) + return self._get_result(request) + + def list_tags(self, user=None, repo=None): + """ Get repository's tags + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + + Remember :ref:`config precedence` + """ + request = self.make_request('repos.list_tags', user=user, repo=repo) + return self._get_result(request) + + def list_branches(self, user=None, repo=None): + """ Get repository's branches + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + + Remember :ref:`config precedence` + """ + request = self.make_request('repos.list_branches', + user=user, repo=repo) + return self._get_result(request) diff --git a/pygithub3/services/repos/collaborators.py b/pygithub3/services/repos/collaborators.py new file mode 100644 index 0000000..3bc4c9d --- /dev/null +++ b/pygithub3/services/repos/collaborators.py @@ -0,0 +1,27 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service + + +class Collaborators(Service): + + def list(self, user=None, repo=None): + request = self.make_request('repos.collaborators.list', + user=user, repo=repo) + return self._get_result(request) + + def add(self, collaborator, user=None, repo=None): + request = self.make_request('repos.collaborators.add', + collaborator=collaborator, user=user, repo=repo) + return self._put(request) + + def is_collaborator(self, collaborator, user=None, repo=None): + request = self.make_request('repos.collaborators.is_collaborator', + collaborator=collaborator, user=user, repo=repo) + return self._bool(request) + + def delete(self, collaborator, user=None, repo=None): + request = self.make_request('repos.collaborators.delete', + collaborator=collaborator, user=user, repo=repo) + self._delete(request) diff --git a/pygithub3/services/repos/commits.py b/pygithub3/services/repos/commits.py new file mode 100644 index 0000000..3d5abb6 --- /dev/null +++ b/pygithub3/services/repos/commits.py @@ -0,0 +1,48 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service, MimeTypeMixin + + +class Commits(Service, MimeTypeMixin): + + """ TODO: Pagination structure differs from usual + def list(self, user=None, repo=None, sha='', path=''): + request = self.make_request('repos.commits.list', user=user, repo=repo) + return self._get_result(request, sha=sha, path=path) + """ + + def get(self, sha, user=None, repo=None): + request = self.make_request('repos.commits.get', + sha=sha, user=user, repo=repo) + return self._get(request) + + def list_comments(self, sha=None, user=None, repo=None): + request = self.make_request('repos.commits.list_comments', + sha=sha, user=user, repo=repo) + return self._get_result(request, **self._get_mimetype_as_header()) + + def create_comment(self, data, sha, user=None, repo=None): + request = self.make_request('repos.commits.create_comment', + sha=sha, user=user, repo=repo, body=data) + return self._post(request, **self._get_mimetype_as_header()) + + def get_comment(self, cid, user=None, repo=None): + request = self.make_request('repos.commits.get_comment', + comment_id=cid, user=user, repo=repo) + return self._get(request, **self._get_mimetype_as_header()) + + def update_comment(self, data, cid, user=None, repo=None): + request = self.make_request('repos.commits.update_comment', + comment_id=cid, user=user, repo=repo, body=data) + return self._patch(request, **self._get_mimetype_as_header()) + + def compare(self, base, head, user=None, repo=None): + request = self.make_request('repos.commits.compare', + base=base, head=head, user=user, repo=repo) + return self._get(request) + + def delete_comment(self, cid, user=None, repo=None): + request = self.make_request('repos.commits.delete_comment', + comment_id=cid, user=user, repo=repo) + self._delete(request) diff --git a/pygithub3/services/repos/downloads.py b/pygithub3/services/repos/downloads.py new file mode 100644 index 0000000..c455021 --- /dev/null +++ b/pygithub3/services/repos/downloads.py @@ -0,0 +1,38 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +import requests + +from . import Service + + +class Downloads(Service): + + def list(self, user=None, repo=None): + request = self.make_request('repos.downloads.list', + user=user, repo=repo) + return self._get_result(request) + + def get(self, id, user=None, repo=None): + request = self.make_request('repos.downloads.get', + id=id, user=user, repo=repo) + return self._get(request) + + def create(self, data, user=None, repo=None): + request = self.make_request('repos.downloads.create', + body=data, user=user, repo=repo) + download = self._post(request) + + # TODO: improve it. e.g Manage all with file desc + def upload(file_path): + body = download.ball_to_upload() + body['file'] = (file_path, open(file_path, 'rb')) + return requests.post(download.s3_url, files=body) + + download.upload = upload + return download + + def delete(self, id=id, user=None, repo=None): + request = self.make_request('repos.downloads.delete', + id=id, user=user, repo=repo) + self._delete(request) diff --git a/pygithub3/services/repos/forks.py b/pygithub3/services/repos/forks.py new file mode 100644 index 0000000..09f23c5 --- /dev/null +++ b/pygithub3/services/repos/forks.py @@ -0,0 +1,17 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service + + +class Forks(Service): + + def list(self, user=None, repo=None, sort='newest'): + request = self.make_request('repos.forks.list', user=user, repo=repo) + return self._get_result(request, sort=sort) + + def create(self, user=None, repo=None, org=None): + request = self.make_request('repos.forks.create', user=user, repo=repo) + #org = {'org': org} if org else {} + org = org and {'org': org} or {} + return self._post(request, **org) diff --git a/pygithub3/services/repos/keys.py b/pygithub3/services/repos/keys.py new file mode 100644 index 0000000..24a7cb3 --- /dev/null +++ b/pygithub3/services/repos/keys.py @@ -0,0 +1,31 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service + + +class Keys(Service): + + def list(self, user=None, repo=None): + request = self.make_request('repos.keys.list', user=user, repo=repo) + return self._get_result(request) + + def get(self, id, user=None, repo=None): + request = self.make_request('repos.keys.get', + id=id, user=user, repo=repo) + return self._get(request) + + def create(self, data, user=None, repo=None): + request = self.make_request('repos.keys.create', + body=data, user=user, repo=repo) + return self._post(request) + + def update(self, id, data, user=None, repo=None): + request = self.make_request('repos.keys.update', + id=id, body=data, user=user, repo=repo) + return self._patch(request) + + def delete(self, id, user=None, repo=None): + request = self.make_request('repos.keys.delete', + id=id, user=user, repo=repo) + self._delete(request) diff --git a/pygithub3/services/repos/watchers.py b/pygithub3/services/repos/watchers.py new file mode 100644 index 0000000..8598590 --- /dev/null +++ b/pygithub3/services/repos/watchers.py @@ -0,0 +1,31 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service + + +class Watchers(Service): + + def list(self, user=None, repo=None): + request = self.make_request('repos.watchers.list', + user=user, repo=repo) + return self._get_result(request) + + def list_repos(self, user=None): + request = self.make_request('repos.watchers.list_repos', user=user) + return self._get_result(request) + + def is_watching(self, user=None, repo=None): + request = self.make_request('repos.watchers.is_watching', + user=user, repo=repo) + return self._bool(request) + + def watch(self, user=None, repo=None): + request = self.make_request('repos.watchers.watch', + user=user, repo=repo) + self._put(request) + + def unwatch(self, user=None, repo=None): + request = self.make_request('repos.watchers.unwatch', + user=user, repo=repo) + self._delete(request) diff --git a/pygithub3/services/users.py b/pygithub3/services/users.py deleted file mode 100644 index 0c8c7aa..0000000 --- a/pygithub3/services/users.py +++ /dev/null @@ -1,233 +0,0 @@ -#!/usr/bin/env python -# -*- encoding: utf-8 -*- - -from .base import Service - - -class Keys(Service): - """ Consume `Keys API <http://developer.github.com/v3/users/keys/>`_ - - .. warning:: - - You must be authenticated for all requests - """ - - def list(self): - """ Get public keys - - :returns: A :doc:`result` - """ - request = self.make_request('users.keys.list') - return self._get_result(request) - - def get(self, key_id): - """ Get a public key - - :param int key_id: Key id - """ - request = self.make_request('users.keys.get', - key_id=key_id) - return self._get(request) - - def add(self, data): - """ Add a public key - - :param dict data: Key (title and key attributes required) - - :: - - key_service.add(dict(title='host', key='ssh-rsa AAA...')) - """ - request = self.make_request('users.keys.add', - body=data) - return self._post(request) - - def update(self, key_id, data): - """ Update a public key - - :param int key_id: Key id - :param dict data: Key (title and key attributes required) - - :: - - key_service.update(42, dict(title='host', key='ssh-rsa AAA...')) - """ - request = self.make_request('users.keys.update', - key_id=key_id, body=data) - return self._patch(request) - - def delete(self, key_id): - """ Delete a public key - - :param int key_id: Key id - """ - request = self.make_request('users.keys.delete', - key_id=key_id) - self._delete(request) - - -class Followers(Service): - """ Consume `Followers API - <http://developer.github.com/v3/users/followers/>`_ - """ - - def list(self, user=None): - """ Get user's followers - - :param str user: Username - :returns: A :doc:`result` - - If you call it without user and you are authenticated, get the - authenticated user's followers - - .. warning:: - - If you aren't authenticated and call without user, it returns 403 - - :: - - followers_service.list() - followers_service.list('octocat') - """ - request = self.make_request('users.followers.list', user=user) - return self._get_result(request) - - def list_following(self, user=None): - """ Get who a user is following - - :param str user: Username - :returns: A :doc:`result` - - If you call it without user and you are authenticated, get the - authenticated user's followings - - .. warning:: - - If you aren't authenticated and call without user, it returns 403 - - :: - - followers_service.list_following() - followers_service.list_following('octocat') - """ - request = self.make_request('users.followers.listfollowing', user=user) - return self._get_result(request) - - def is_following(self, user): - """ Check if you are following a user - - :param str user: Username - """ - request = self.make_request('users.followers.isfollowing', user=user) - return self._bool(request) - - def follow(self, user): - """ Follow a user - - :param str user: Username - - .. warning:: - - You must be authenticated - """ - request = self.make_request('users.followers.follow', user=user) - self._put(request) - - def unfollow(self, user): - """ Unfollow a user - - :param str user: Username - - .. warning:: - - You must be authenticated - """ - request = self.make_request('users.followers.unfollow', user=user) - self._delete(request) - - -class Emails(Service): - """ Consume `Emails API <http://developer.github.com/v3/users/emails/>`_ - - .. warning:: - - You must be authenticated for all requests - """ - - def list(self): - """ Get user's emails - - :returns: A :doc:`result` - """ - request = self.make_request('users.emails.list') - return self._get_result(request) - - def add(self, *emails): - """ Add emails - - :param list emails: Emails to add - - .. note:: - - It rejects non-valid emails - - :: - - email_service.add('test1@xample.com', 'test2@xample.com') - """ - request = self.make_request('users.emails.add', body=emails) - return self._post(request) - - def delete(self, *emails): - """ Delete emails - - :param list emails: List of emails - - :: - - email_service.delete('test1@xample.com', 'test2@xample.com') - """ - request = self.make_request('users.emails.delete', body=emails) - self._delete(request) - - -class User(Service): - """ Consume `Users API <http://developer.github.com/v3/users>`_ """ - - def __init__(self, **config): - self.keys = Keys(**config) - self.emails = Emails(**config) - self.followers = Followers(**config) - super(User, self).__init__(**config) - - def get(self, user=None): - """ Get a single user - - :param str user: Username - - If you call it without user and you are authenticated, get the - authenticated user. - - .. warning:: - - If you aren't authenticated and call without user, it returns 403 - - :: - - user_service.get('copitux') - user_service.get() - """ - request = self.make_request('users.get', user=user) - return self._get(request) - - def update(self, data): - """ Update the authenticated user - - :param dict data: Input to update - - :: - - user_service.update(dict(name='new_name', bio='new_bio')) - """ - request = self.make_request('users.update', body=data) - return self._patch(request) diff --git a/pygithub3/services/users/__init__.py b/pygithub3/services/users/__init__.py new file mode 100644 index 0000000..c448319 --- /dev/null +++ b/pygithub3/services/users/__init__.py @@ -0,0 +1,49 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from ..base import Service +from .keys import Keys +from .emails import Emails +from .followers import Followers + + +class User(Service): + """ Consume `Users API <http://developer.github.com/v3/users>`_ """ + + def __init__(self, **config): + self.keys = Keys(**config) + self.emails = Emails(**config) + self.followers = Followers(**config) + super(User, self).__init__(**config) + + def get(self, user=None): + """ Get a single user + + :param str user: Username + + If you call it without user and you are authenticated, get the + authenticated user. + + .. warning:: + + If you aren't authenticated and call without user, it returns 403 + + :: + + user_service.get('copitux') + user_service.get() + """ + request = self.make_request('users.get', user=user) + return self._get(request) + + def update(self, data): + """ Update the authenticated user + + :param dict data: Input to update + + :: + + user_service.update(dict(name='new_name', bio='new_bio')) + """ + request = self.make_request('users.update', body=data) + return self._patch(request) diff --git a/pygithub3/services/users/emails.py b/pygithub3/services/users/emails.py new file mode 100644 index 0000000..084a29c --- /dev/null +++ b/pygithub3/services/users/emails.py @@ -0,0 +1,49 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service + + +class Emails(Service): + """ Consume `Emails API <http://developer.github.com/v3/users/emails/>`_ + + .. warning:: + + You must be authenticated for all requests + """ + + def list(self): + """ Get user's emails + + :returns: A :doc:`result` + """ + request = self.make_request('users.emails.list') + return self._get_result(request) + + def add(self, *emails): + """ Add emails + + :param list emails: Emails to add + + .. note:: + + It rejects non-valid emails + + :: + + email_service.add('test1@xample.com', 'test2@xample.com') + """ + request = self.make_request('users.emails.add', body=emails) + return self._post(request) + + def delete(self, *emails): + """ Delete emails + + :param list emails: List of emails + + :: + + email_service.delete('test1@xample.com', 'test2@xample.com') + """ + request = self.make_request('users.emails.delete', body=emails) + self._delete(request) diff --git a/pygithub3/services/users/followers.py b/pygithub3/services/users/followers.py new file mode 100644 index 0000000..d6969e2 --- /dev/null +++ b/pygithub3/services/users/followers.py @@ -0,0 +1,84 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service + + +class Followers(Service): + """ Consume `Followers API + <http://developer.github.com/v3/users/followers/>`_ + """ + + def list(self, user=None): + """ Get user's followers + + :param str user: Username + :returns: A :doc:`result` + + If you call it without user and you are authenticated, get the + authenticated user's followers + + .. warning:: + + If you aren't authenticated and call without user, it returns 403 + + :: + + followers_service.list() + followers_service.list('octocat') + """ + request = self.make_request('users.followers.list', user=user) + return self._get_result(request) + + def list_following(self, user=None): + """ Get who a user is following + + :param str user: Username + :returns: A :doc:`result` + + If you call it without user and you are authenticated, get the + authenticated user's followings + + .. warning:: + + If you aren't authenticated and call without user, it returns 403 + + :: + + followers_service.list_following() + followers_service.list_following('octocat') + """ + request = self.make_request('users.followers.listfollowing', user=user) + return self._get_result(request) + + def is_following(self, user): + """ Check if you are following a user + + :param str user: Username + """ + request = self.make_request('users.followers.isfollowing', user=user) + return self._bool(request) + + def follow(self, user): + """ Follow a user + + :param str user: Username + + .. warning:: + + You must be authenticated + """ + request = self.make_request('users.followers.follow', user=user) + self._put(request) + + def unfollow(self, user): + """ Unfollow a user + + :param str user: Username + + .. warning:: + + You must be authenticated + """ + request = self.make_request('users.followers.unfollow', user=user) + self._delete(request) diff --git a/pygithub3/services/users/keys.py b/pygithub3/services/users/keys.py new file mode 100644 index 0000000..996233c --- /dev/null +++ b/pygithub3/services/users/keys.py @@ -0,0 +1,66 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service + + +class Keys(Service): + """ Consume `Keys API <http://developer.github.com/v3/users/keys/>`_ + + .. warning:: + + You must be authenticated for all requests + """ + + def list(self): + """ Get public keys + + :returns: A :doc:`result` + """ + request = self.make_request('users.keys.list') + return self._get_result(request) + + def get(self, key_id): + """ Get a public key + + :param int key_id: Key id + """ + request = self.make_request('users.keys.get', + key_id=key_id) + return self._get(request) + + def add(self, data): + """ Add a public key + + :param dict data: Key (title and key attributes required) + + :: + + key_service.add(dict(title='host', key='ssh-rsa AAA...')) + """ + request = self.make_request('users.keys.add', + body=data) + return self._post(request) + + def update(self, key_id, data): + """ Update a public key + + :param int key_id: Key id + :param dict data: Key (title and key attributes required) + + :: + + key_service.update(42, dict(title='host', key='ssh-rsa AAA...')) + """ + request = self.make_request('users.keys.update', + key_id=key_id, body=data) + return self._patch(request) + + def delete(self, key_id): + """ Delete a public key + + :param int key_id: Key id + """ + request = self.make_request('users.keys.delete', + key_id=key_id) + self._delete(request) |