aboutsummaryrefslogtreecommitdiffstats
path: root/pygithub3/services/repos/keys.py
blob: 1ade8a197f0eea37418357d14c0c09fb70895a46 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
#!/usr/bin/env python
# -*- encoding: utf-8 -*-

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)