diff options
author | 2012-06-03 13:02:54 +0200 | |
---|---|---|
committer | 2012-06-03 13:02:54 +0200 | |
commit | 897671db979e64754de2c53cbbe83fcbae37bb02 (patch) | |
tree | 11ac9ede303971d2bcaf270d833fd4112c923509 /pygithub3/services | |
parent | Merge 'services/orgs' (diff) | |
parent | Change "Edit" to "Update" in docstring (diff) | |
download | python-github3-897671db979e64754de2c53cbbe83fcbae37bb02.tar.xz python-github3-897671db979e64754de2c53cbbe83fcbae37bb02.zip |
Merge branch 'services/issues' of https://github.com/alejandrogomez/python-github3 into services/issues
Conflicts:
docs/services.rst
pygithub3/github.py
pygithub3/requests/repos/__init__.py
Diffstat (limited to 'pygithub3/services')
-rw-r--r-- | pygithub3/services/issues/__init__.py | 85 | ||||
-rw-r--r-- | pygithub3/services/issues/comments.py | 75 | ||||
-rw-r--r-- | pygithub3/services/issues/events.py | 42 | ||||
-rw-r--r-- | pygithub3/services/issues/labels.py | 160 | ||||
-rw-r--r-- | pygithub3/services/issues/milestones.py | 105 | ||||
-rw-r--r-- | pygithub3/services/repos/__init__.py | 30 |
6 files changed, 497 insertions, 0 deletions
diff --git a/pygithub3/services/issues/__init__.py b/pygithub3/services/issues/__init__.py new file mode 100644 index 0000000..e8e3493 --- /dev/null +++ b/pygithub3/services/issues/__init__.py @@ -0,0 +1,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) diff --git a/pygithub3/services/issues/comments.py b/pygithub3/services/issues/comments.py new file mode 100644 index 0000000..d007286 --- /dev/null +++ b/pygithub3/services/issues/comments.py @@ -0,0 +1,75 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from pygithub3.services.base import Service + +class Comments(Service): + """ Consume `Comments API + <http://developer.github.com/v3/issues/comments>`_ """ + + def list(self, user, repo, number): + """ List comments for an issue + + :param str user: Username + :param str repo: Repo name + :param int number: Issue number + :returns: A :doc:`result` + """ + request = self.request_builder('issues.comments.list', user=user, + repo=repo, number=number) + return self._get_result(request) + + def get(self, user, repo, id): + """ Get a single comment + + :param str user: Username + :param str repo: Repo name + :param int id: Comment id + """ + request = self.request_builder('issues.comments.get', user=user, + repo=repo, id=id) + return self._get(request) + + def create(self, user, repo, number, message): + """ Create a comment on an issue + + :param str user: Username + :param str repo: Repo name + :param int number: Issue number + :param str message: Comment message + + .. warning:: + You must be authenticated + """ + request = self.request_builder('issues.comments.create', user=user, + repo=repo, number=number, body={'body': message}) + return self._post(request) + + def update(self, user, repo, id, message): + """ Update a comment on an issue + + :param str user: Username + :param str repo: Repo name + :param int id: Issue id + :param str message: Comment message + + .. warning:: + You must be authenticated + """ + request = self.request_builder('issues.comments.edit', user=user, + repo=repo, id=id, body={'body': message}) + return self._patch(request) + + def delete(self, user, repo, id): + """ Delete a single comment + + :param str user: Username + :param str repo: Repo name + :param int id: Comment id + + .. warning:: + You must be authenticated + """ + request = self.request_builder('issues.comments.delete', user=user, + repo=repo, id=id) + self._delete(request) diff --git a/pygithub3/services/issues/events.py b/pygithub3/services/issues/events.py new file mode 100644 index 0000000..8eb35e4 --- /dev/null +++ b/pygithub3/services/issues/events.py @@ -0,0 +1,42 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from pygithub3.services.base import Service + +class Events(Service): + """ Consume `Events API + <http://developer.github.com/v3/issues/events>`_ """ + + def list_by_issue(self, user, repo, number): + """ List events for an issue + + :param str user: Username + :param str repo: Repo name + :param int number: Issue number + :returns: A :doc:`result` + """ + request = self.request_builder('issues.events.list_by_issue', + user=user, repo=repo, number=number) + return self._get_result(request) + + def list_by_repo(self, user, repo): + """ List events for a repository + + :param str user: Username + :param str repo: Repo name + :returns: A :doc:`result` + """ + request = self.request_builder('issues.events.list_by_repo', + user=user, repo=repo) + return self._get_result(request) + + def get(self, user, repo, id): + """ Get a single event + + :param str user: Username + :param str repo: Repo name + :param int id: Comment id + """ + request = self.request_builder('issues.events.get', user=user, + repo=repo, id=id) + return self._get(request) diff --git a/pygithub3/services/issues/labels.py b/pygithub3/services/issues/labels.py new file mode 100644 index 0000000..6aea6e7 --- /dev/null +++ b/pygithub3/services/issues/labels.py @@ -0,0 +1,160 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from pygithub3.services.base import Service + + +class Labels(Service): + """ Consume `Labels API + <http://developer.github.com/v3/issues/labels>`_ """ + + def get(self, user, repo, name): + """ Get a single label + + :param str user: Username + :param str repo: Repo name + :param str name: Label name + """ + request = self.request_builder('issues.labels.get', user=user, + repo=repo, name=name) + return self._get(request) + + def create(self, user, repo, name, color): + """ Create a label on an repo + + :param str user: Username + :param str repo: Repo name + :param str name: Label name + :param str color: Label color + + .. warning:: + You must be authenticated + """ + request = self.request_builder('issues.labels.create', + user=user, + repo=repo, + body={'name': name, + 'color': color,}) + return self._post(request) + + def update(self, user, repo, name, new_name, color): + """ Update a label on an repo + + :param str user: Username + :param str repo: Repo name + :param str name: Label name + :param str name: Label new name + :param str color: Label color + + .. warning:: + You must be authenticated + """ + request = self.request_builder('issues.labels.update', + user=user, + repo=repo, + name=name, + body={'name': new_name, + 'color': color,}) + return self._patch(request) + + def delete(self, user, repo, name): + """ Delete a label on an repo + + :param str user: Username + :param str repo: Repo name + :param str name: Label name + + .. warning:: + You must be authenticated + """ + request = self.request_builder('issues.labels.delete', + user=user, + repo=repo, + name=name) + return self._delete(request) + + def list_by_repo(self, user, repo): + """ List all labels for a repo + + :param str user: Username + :param str repo: Repo name + :returns: A :doc:`result` + """ + request = self.request_builder('issues.labels.list_by_repo', + user=user, + repo=repo,) + return self._get(request) + + def list_by_issue(self, user, repo, number): + """ List labels for an issue + + :param str user: Username + :param str repo: Repo name + :param int number: Issue number + :returns: A :doc:`result` + """ + request = self.request_builder('issues.labels.list_by_issue', user=user, + repo=repo, number=number) + return self._get(request) + + def add_to_issue(self, user, repo, number, labels): + """ Add labels to issue + + :param str user: Username + :param str repo: Repo name + :param int number: Issue number + :param list labels: List of label names + :returns: A :doc:`result` + """ + request = self.request_builder('issues.labels.add_to_issue', + user=user, + repo=repo, + number=number, + body=labels) + return self._post(request) + + def remove_from_issue(self, user, repo, number, label): + """ Remove a label from an issue + + :param str user: Username + :param str repo: Repo name + :param int number: Issue number + :param str label: Label name + :returns: A :doc:`result` + """ + request = self.request_builder('issues.labels.remove_from_issue', + user=user, + repo=repo, + number=number, + name=label) + return self._delete(request) + + def replace_all(self, user, repo, number, labels): + """ Replace all labels of a issue + + :param str user: Username + :param str repo: Repo name + :param int number: Issue number + :param list labels: New labels + :returns: A :doc:`result` + """ + request = self.request_builder('issues.labels.replace_all', + user=user, + repo=repo, + number=number, + body=labels,) + return self._put(request) + + def remove_all(self, user, repo, number): + """ Remove all labels from a issue + + :param str user: Username + :param str repo: Repo name + :param int number: Issue number + :returns: A :doc:`result` + """ + request = self.request_builder('issues.labels.remove_all', + user=user, + repo=repo, + number=number,) + return self._delete(request) diff --git a/pygithub3/services/issues/milestones.py b/pygithub3/services/issues/milestones.py new file mode 100644 index 0000000..851e9f2 --- /dev/null +++ b/pygithub3/services/issues/milestones.py @@ -0,0 +1,105 @@ +#!/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, repo): + """ List milestones for a repo + + :param str user: Username + :param str repo: Repo name + :returns: A :doc:`result` + """ + request = self.request_builder('issues.milestones.list', + user=user, + repo=repo) + return self._get_result(request) + + def get(self, user, repo, number): + """ Get a single milestone + + :param str user: Username + :param str repo: Repo name + :param int number: Milestone number + """ + request = self.request_builder('issues.milestones.get', user=user, + repo=repo, number=number) + return self._get(request) + + def create(self, + user, + repo, + title, + state=None, + description=None, + due_on=None): + """ Create a milestone + + :param str user: Username + :param str repo: Repo name + :param str title: Milestone title + :param str state: Milestone state + :param str description: Milestone description + :param date due_on: Milestone due date + + .. warning:: + You must be authenticated + """ + request = self.request_builder('issues.milestones.create', + user=user, + repo=repo, + body={'title': title, + 'state': state, + 'due_on': due_on}) + return self._post(request) + + def update(self, + user, + repo, + number, + title, + state=None, + description=None, + due_on=None): + """ Update a milestone + + :param str user: Username + :param str repo: Repo name + :param int number: Milestone number + :param str title: Milestone title + :param str state: Milestone state + :param str description: Milestone description + :param date due_on: Milestone due date + + .. warning:: + You must be authenticated + """ + request = self.request_builder('issues.milestones.update', + user=user, + repo=repo, + number=number, + body={'title': title, + 'state': state, + 'description': description, + 'due_on': due_on, }) + return self._patch(request) + + def delete(self, user, repo, number): + """ Delete a milestone + + :param str user: Username + :param str repo: Repo name + :param int number: Milestone number + + .. warning:: + You must be authenticated + """ + request = self.request_builder('issues.milestones.delete', + user=user, + repo=repo, + number=number) + self._delete(request) diff --git a/pygithub3/services/repos/__init__.py b/pygithub3/services/repos/__init__.py index 628e9d6..a7e61fc 100644 --- a/pygithub3/services/repos/__init__.py +++ b/pygithub3/services/repos/__init__.py @@ -190,3 +190,33 @@ class Repo(Service): request = self.make_request('repos.list_branches', user=user, repo=repo) return self._get_result(request) + + def list_labels(self, user=None, repo=None): + """ Get repository's labels + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` + """ + request = self.make_request('repos.list_labels', + user=user, + repo=repo) + return self._get_result(request) + + def list_milestones(self, user=None, repo=None): + """ Get repository's milestones + + :param str user: Username + :param str repo: Repository + :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` + """ + request = self.make_request('repos.list_milestones', + user=user, + repo=repo) + return self._get_result(request) |