diff options
author | 2012-03-01 19:41:46 +0100 | |
---|---|---|
committer | 2012-03-01 19:43:26 +0100 | |
commit | 5d7ee35eb23f193ec79a1a7b24ea87c6f1bc28b8 (patch) | |
tree | c90ab9489c5217151c1f1c716aea8fa39b303393 /pygithub3/services/repos/keys.py | |
parent | WIP on services.repos doc (diff) | |
download | python-github3-5d7ee35eb23f193ec79a1a7b24ea87c6f1bc28b8.tar.xz python-github3-5d7ee35eb23f193ec79a1a7b24ea87c6f1bc28b8.zip |
Complete services.repos doc
Also add Mimetypes doc
Diffstat (limited to 'pygithub3/services/repos/keys.py')
-rw-r--r-- | pygithub3/services/repos/keys.py | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/pygithub3/services/repos/keys.py b/pygithub3/services/repos/keys.py index 24a7cb3..1ade8a1 100644 --- a/pygithub3/services/repos/keys.py +++ b/pygithub3/services/repos/keys.py @@ -5,27 +5,91 @@ from . import Service class Keys(Service): + """ Consume `Deploy keys API + <http://developer.github.com/v3/repos/keys>`_ """ def list(self, user=None, repo=None): + """ Get repository's keys + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` + """ request = self.make_request('repos.keys.list', user=user, repo=repo) return self._get_result(request) def get(self, id, user=None, repo=None): + """ Get a single repository key + + :param int id: Repository key id + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + """ 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): + """ Create a repository key + + :param dict data: Input. See `github keys doc`_ + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + + .. warning:: + You must be authenticated and have perms in the repository + + :: + + keys_service.create(dict(title='new key', key='ssh-rsa AAA...'), + user='octocat', repo='oct_repo') + """ 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): + """ Update a repository key + + :param int id: Repository key id + :param dict data: Input. See `github keys doc`_ + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + + .. warning:: + You must be authenticated and have perms in the repository + + :: + + keys_service.update(42, dict(title='new title'), + user='octocat', repo='oct_repo') + """ 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): + """ Delete a repository key + + :param int id: Repository key id + :param str user: Username + :param str repo: Repository + + .. note:: + Remember :ref:`config precedence` + """ request = self.make_request('repos.keys.delete', id=id, user=user, repo=repo) self._delete(request) |