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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
#!/usr/bin/env python
# -*- encoding: utf-8 -*-
from pygithub3.services.base import Service
from comments import Comments
class Gist(Service):
""" Consume `Gists API <http://developer.github.com/v3/gists>`_ """
def __init__(self, **config):
self.comments = Comments(**config)
super(Gist, self).__init__(**config)
def list(self, user=None):
""" Get user's gists
:param str user: Username
:returns: A :doc:`result`
If you call it without user and you are authenticated, get the
authenticated user's gists. but if you aren't authenticated get the
public gists
::
gist_service.list('copitux')
gist_service.list()
"""
request = self.request_builder('gists.list', user=user)
return self._get_result(request)
def public(self):
""" Get public gists
:returns: A :doc:`result`
.. note ::
Be careful iterating the result
"""
request = self.request_builder('gists.public')
return self._get_result(request)
def starred(self):
""" Get authenticated user's starred gists
:returns: A :doc:`result`
.. warning::
You must be authenticated
"""
request = self.request_builder('gists.starred')
return self._get_result(request)
def get(self, id):
""" Get a single gist
:param int id: Gist id
"""
request = self.request_builder('gists.get', id=id)
return self._get(request)
def create(self, data):
""" Create a gist
:param dict data: Input. See `github gists doc`_
::
gist_service.create(dict(description='some gist', public=True,
files={'xample.py': {'content': 'import code'}}))
"""
request = self.request_builder('gists.create', body=data)
return self._post(request)
def update(self, id, data):
""" Update a single gist
:param int id: Gist id
:param dict data: Input. See `github gists doc`_
.. warning ::
You must be authenticated
::
gist_service.update(dict(description='edited',
files={'xample.py': {
'filename': 'new_xample.py',
'content': 'import new_code'}}))
"""
request = self.request_builder('gists.update', id=id, body=data)
return self._patch(request)
def star(self, id):
""" Star a gist
:param int id: Gist id
.. warning ::
You must be authenticated
"""
request = self.request_builder('gists.star', id=id)
self._put(request)
def unstar(self, id):
""" Unstar a gist
:param int id: Gist id
.. warning ::
You must be authenticated
"""
request = self.request_builder('gists.unstar', id=id)
return self._delete(request)
def is_starred(self, id):
""" Check if a gist is starred
:param int id: Gist id
.. warning ::
You must be authenticated
"""
request = self.request_builder('gists.is_starred', id=id)
return self._bool(request)
def fork(self, id):
""" Fork a gist
:param int id: Gist id
.. warning ::
You must be authenticated
"""
request = self.request_builder('gists.fork', id=id)
return self._post(request)
def delete(self, id):
""" Delete a gist
:param int id: Gist id
.. warning ::
You must be authenticated
"""
request = self.request_builder('gists.delete', id=id)
return self._delete(request)
|
