aboutsummaryrefslogtreecommitdiffstats
path: root/pygithub3/services/repos/collaborators.py
diff options
context:
space:
mode:
authorDavid Medina <davidmedina9@gmail.com>2012-03-01 14:10:48 +0100
committerDavid Medina <davidmedina9@gmail.com>2012-03-01 14:10:48 +0100
commit614ed5b2acf916b71803532e499df9068b6273bd (patch)
tree9e5ed8fa41c824047e73ca7a1ede33e3e66941f2 /pygithub3/services/repos/collaborators.py
parentRestructure modules and packages in a clean way (diff)
downloadpython-github3-614ed5b2acf916b71803532e499df9068b6273bd.tar.xz
python-github3-614ed5b2acf916b71803532e499df9068b6273bd.zip
WIP on services.repos doc
+services.repos.collaborators doc +services.repos.commits doc
Diffstat (limited to 'pygithub3/services/repos/collaborators.py')
-rw-r--r--pygithub3/services/repos/collaborators.py50
1 files changed, 50 insertions, 0 deletions
diff --git a/pygithub3/services/repos/collaborators.py b/pygithub3/services/repos/collaborators.py
index 3bc4c9d..5f0703a 100644
--- a/pygithub3/services/repos/collaborators.py
+++ b/pygithub3/services/repos/collaborators.py
@@ -5,23 +5,73 @@ from . import Service
class Collaborators(Service):
+ """ Consume `Repo Collaborators API
+ <http://developer.github.com/v3/repos/collaborators>`_ """
def list(self, user=None, repo=None):
+ """ Get repository's collaborators
+
+ :param str user: Username
+ :param str repo: Repository
+ :returns: A :doc:`result`
+
+ .. note::
+
+ Remember :ref:`config precedence`
+ """
request = self.make_request('repos.collaborators.list',
user=user, repo=repo)
return self._get_result(request)
def add(self, collaborator, user=None, repo=None):
+ """ Add collaborator to a repository
+
+ :param str collaborator: Collaborator's username
+ :param str user: Username
+ :param str repo: Repository
+
+ .. note::
+
+ Remember :ref:`config precedence`
+
+ .. warning::
+
+ You must be authenticated and have perms in repository
+ """
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):
+ """ Check if a user is collaborator on repository
+
+ :param str collaborator: Collaborator's username
+ :param str user: Username
+ :param str repo: Repository
+
+ .. note::
+
+ Remember :ref:`config precedence`
+ """
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):
+ """ Remove collaborator from repository
+
+ :param str collaborator: Collaborator's username
+ :param str user: Username
+ :param str repo: Repository
+
+ .. note::
+
+ Remember :ref:`config precedence`
+
+ .. warning::
+
+ You must be authenticated and have perms in repository
+ """
request = self.make_request('repos.collaborators.delete',
collaborator=collaborator, user=user, repo=repo)
self._delete(request)