aboutsummaryrefslogtreecommitdiffstats
path: root/pygithub3/services/issues/__init__.py
blob: e8e34933e4e84d667eac338750bc56fa0d591b95 (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
# -*- encoding: utf-8 -*-

from pygithub3.services.base import Service
from .comments import Comments
from .events import Events
from .labels import Labels
from .milestones import Milestones

class Issue(Service):
    """ Consume `Issues API <http://developer.github.com/v3/issues>`_ """

    def __init__(self, **config):
        self.comments = Comments(**config)
        self.events = Events(**config)
        self.labels = Labels(**config)
        self.milestones = Milestones(**config)
        super(Issue, self).__init__(**config)

    def list(self, data={}):
        """ List your issues

        :param dict data: Input. See `github issues doc`_
        :returns: A :doc:`result`

        .. warning::
            You must be authenticated
        """
        request = self.request_builder('issues.list', body=data)
        return self._get_result(request)

    def list_by_repo(self, user, repo, data={}):
        """ List issues for a repo

        :param dict data: Input. See `github issues doc`_
        :returns: A :doc:`result`
        """
        request = self.request_builder('issues.list_by_repo', user=user, 
            repo=repo, body=data)
        return self._get_result(request)

    def get(self, user, repo, number):
        """ Get a single issue

        :param str user: Username
        :param str repo: Repo name
        :param int number: Issue number
        """
        request = self.request_builder('issues.get', user=user, repo=repo,
            number=number)
        return self._get(request)

    def create(self, user, repo, data):
        """ Create an issue

        :param str user: Username
        :param str repo: Repo name
        :param dict data: Input. See `github issues doc`_

        .. warning::
            You must be authenticated

        ::

            issues_service.create(dict(title='My test issue', 
                body='This needs to be fixed ASAP.',
                assignee='copitux'))
        """
        request = self.request_builder('issues.create', user=user, repo=repo,
            body=data)
        return self._post(request)

    def update(self, user, repo, number, data):
        """ Update an issue

        :param str user: Username
        :param str repo: Repo name
        :param int number: Issue number
        :param dict data: Input. See `github issues doc`_

        .. warning::
            You must be authenticated
        """
        request = self.request_builder('issues.edit', user=user, repo=repo,
            number=number, body=data)
        return self._patch(request)