aboutsummaryrefslogtreecommitdiffstats
path: root/pygithub3/services/issues/milestones.py
blob: ac43a0c48ff7bfae85ca446cd424eecf8bb13bbd (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
96
#!/usr/bin/env python
# -*- encoding: utf-8 -*-

from pygithub3.services.base import Service


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

    def list(self, user=None, repo=None, state='open', sort='due_date',
            direction='desc'):
        """ List milestones for a repo

        :param str user: Username
        :param str repo: Repo name
        :param str state: 'open' or 'closed'
        :param str sort: 'due_date' or 'completeness'
        :param str direction: 'asc' or 'desc'
        :returns: A :doc:`result`

        .. note::
            Remember :ref:`config precedence`
        """
        request = self.make_request('issues.milestones.list', user=user,
            repo=repo)
        return self._get_result(request, state=state, sort=sort,
            direction=direction)

    def get(self, number, user=None, repo=None):
        """ Get a single milestone

        :param int number: Milestone number
        :param str user: Username
        :param str repo: Repo name

        .. note::
            Remember :ref:`config precedence`
        """
        request = self.make_request('issues.milestones.get', user=user,
            repo=repo, number=number)
        return self._get(request)

    def create(self, data, user=None, repo=None):
        """ Create a milestone

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

        .. warning::
            You must be authenticated

        .. note::
            Remember :ref:`config precedence`
        """
        self._normalize_date('due_on', data)
        request = self.make_request('issues.milestones.create', user=user,
            repo=repo, body=data)
        return self._post(request)

    def update(self, number, data, user=None, repo=None):
        """ Update a milestone

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

        .. warning::
            You must be authenticated

        .. note::
            Remember :ref:`config precedence`
        """
        self._normalize_date('due_on', data)
        request = self.make_request('issues.milestones.update', user=user,
            repo=repo, number=number, body=data)
        return self._patch(request)

    def delete(self, number, user=None, repo=None):
        """ Delete a milestone

        :param int number: Milestone number
        :param str user: Username
        :param str repo: Repo name

        .. warning::
            You must be authenticated

        .. note::
            Remember :ref:`config precedence`
        """
        request = self.make_request('issues.milestones.delete', user=user,
            repo=repo, number=number)
        self._delete(request)