File: Issue.rst

package info (click to toggle)
pygithub 2.6.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 33,476 kB
  • sloc: python: 38,409; sh: 7; makefile: 6
file content (78 lines) | stat: -rw-r--r-- 2,004 bytes parent folder | download
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
Issues
======

Get issue
---------

.. code-block:: python

    >>> repo = g.get_repo("PyGithub/PyGithub")
    >>> repo.get_issue(number=874)
	Issue(title="PyGithub example usage", number=874)

Create comment on issue
-----------------------

.. code-block:: python

    >>> repo = g.get_repo("PyGithub/PyGithub")
    >>> issue = repo.get_issue(number=874)
    >>> issue.create_comment("Test")
    	IssueComment(user=NamedUser(login="user"), id=36763078)

Create issue
------------

.. code-block:: python

    >>> repo = g.get_repo("PyGithub/PyGithub")
    >>> repo.create_issue(title="This is a new issue")
	Issue(title="This is a new issue", number=XXX)

Create issue with body
----------------------

.. code-block:: python

    >>> repo = g.get_repo("PyGithub/PyGithub")
    >>> repo.create_issue(title="This is a new issue", body="This is the issue body")
	Issue(title="This is a new issue", number=XXX)

Create issue with labels
------------------------

.. code-block:: python

    >>> repo = g.get_repo("PyGithub/PyGithub")
    >>> label = repo.get_label("My Label")
    >>> repo.create_issue(title="This is a new issue", labels=[label])
	Issue(title="This is a new issue", number=XXX)

Create issue with assignee
--------------------------

.. code-block:: python

    >>> repo = g.get_repo("PyGithub/PyGithub")
    >>> repo.create_issue(title="This is a new issue", assignee="github-username")
	Issue(title="This is a new issue", number=XXX)

Create issue with milestone
---------------------------

.. code-block:: python

    >>> repo = g.get_repo("PyGithub/PyGithub")
    >>> milestone = repo.create_milestone("New Issue Milestone")
    >>> repo.create_issue(title="This is a new issue", milestone=milestone)
	Issue(title="This is a new issue", number=XXX)

Close all issues
-----------------

.. code-block:: python

    >>> repo = g.get_repo("PyGithub/PyGithub")
    >>> open_issues = repo.get_issues(state='open')
    >>> for issue in open_issues:
    ...     issue.edit(state='closed')