diff options
Diffstat (limited to 'pygithub3/services/issues')
| -rw-r--r-- | pygithub3/services/issues/__init__.py | 82 | ||||
| -rw-r--r-- | pygithub3/services/issues/comments.py | 75 | ||||
| -rw-r--r-- | pygithub3/services/issues/events.py | 42 |
3 files changed, 199 insertions, 0 deletions
diff --git a/pygithub3/services/issues/__init__.py b/pygithub3/services/issues/__init__.py new file mode 100644 index 0000000..0699f9e --- /dev/null +++ b/pygithub3/services/issues/__init__.py @@ -0,0 +1,82 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from pygithub3.services.base import Service +from .comments import Comments +from .events import Events + +class Issue(Service): + """ Consume `Issues API <http://developer.github.com/v3/issues>`_ """ + + def __init__(self, **config): + self.comments = Comments(**config) + self.events = Events(**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): + """ Edit 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)
\ No newline at end of file diff --git a/pygithub3/services/issues/comments.py b/pygithub3/services/issues/comments.py new file mode 100644 index 0000000..f367a58 --- /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)
\ No newline at end of file diff --git a/pygithub3/services/issues/events.py b/pygithub3/services/issues/events.py new file mode 100644 index 0000000..0111db4 --- /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)
\ No newline at end of file |