|
3 | 3 | History/Changelog
|
4 | 4 | -----------------
|
5 | 5 |
|
6 |
| -1.0.0: 2014-xx-xx |
7 |
| -~~~~~~~~~~~~~~~~~ |
8 |
| - |
9 |
| -1.0.0 is a huge release. It includes a great deal of changes to ``github3.py``. |
10 |
| -It is suggested you read the following release notes *very* carefully. |
11 |
| - |
12 |
| -Breaking Changes |
13 |
| -```````````````` |
14 |
| - |
15 |
| -- ``Organization#add_member`` has been changed. The second parameter has been |
16 |
| - changed to ``team_id`` and now expects an integer. |
17 |
| - |
18 |
| -- ``Organization#add_repository`` has been changed. The second parameter has been |
19 |
| - changed to ``team_id`` and now expects an integer. |
20 |
| - |
21 |
| -- All methods and functions starting with ``iter_`` have been renamed. |
22 |
| - |
23 |
| -========================================== ============================================== |
24 |
| -Old name New name |
25 |
| -========================================== ============================================== |
26 |
| -``github3.iter_all_repos`` ``github3.all_repositories`` |
27 |
| -``github3.iter_all_users`` ``github3.all_users`` |
28 |
| -``github3.iter_events`` ``github3.all_events`` |
29 |
| -``github3.iter_followers`` ``github3.followers_of`` |
30 |
| -``github3.iter_following`` ``github3.followed_by`` |
31 |
| -``github3.iter_repo_issues`` ``github3.repository_issues`` |
32 |
| -``github3.iter_orgs`` ``github3.organizations_with`` |
33 |
| -``github3.iter_user_repos`` ``github3.repositories_by`` |
34 |
| -``github3.iter_starred`` ``github3.starred_by`` |
35 |
| -``github3.iter_subscriptions`` ``github3.subscriptions_for`` |
36 |
| -``Gist#iter_comments`` ``Gist#comments`` |
37 |
| -``Gist#iter_commits`` ``Gist#commits`` |
38 |
| -``Gist#iter_files`` ``Gist#files`` |
39 |
| -``Gist#iter_forks`` ``Gist#forks`` |
40 |
| -``GitHub#iter_all_repos`` ``GitHub#all_repositories`` |
41 |
| -``GitHub#iter_all_users`` ``GitHub#all_users`` |
42 |
| -``GitHub#iter_authorizations`` ``GitHub#authorizations`` |
43 |
| -``GitHub#iter_emails`` ``GitHub#emails`` |
44 |
| -``GitHub#iter_events`` ``GitHub#events`` |
45 |
| -``GitHub#iter_followers`` ``GitHub#{followers,followers_of}`` |
46 |
| -``GitHub#iter_following`` ``GitHub#{following,followed_by}`` |
47 |
| -``GitHub#iter_gists`` ``GitHub#{gists,gists_by,public_gists}`` |
48 |
| -``GitHub#iter_notifications`` ``GitHub#notifications`` |
49 |
| -``GitHub#iter_org_issues`` ``GitHub#organization_issues`` |
50 |
| -``GitHub#iter_issues`` ``GitHub#issues`` |
51 |
| -``GitHub#iter_user_issues`` ``GitHub#user_issues`` |
52 |
| -``GitHub#iter_repo_issues`` ``GitHub#repository_issues`` |
53 |
| -``GitHub#iter_keys`` ``GitHub#keys`` |
54 |
| -``GitHub#iter_orgs`` ``GitHub#{organizations,organizations_with}`` |
55 |
| -``GitHub#iter_repos`` ``GitHub#reposistories`` |
56 |
| -``GitHub#iter_user_repos`` ``GitHub#repositories_by`` |
57 |
| -``GitHub#iter_user_teams`` ``GitHub#user_teams`` |
58 |
| -``Issue#iter_comments`` ``Issue#comments`` |
59 |
| -``Organization#iter_members`` ``Organization#members`` |
60 |
| -``Organization#iter_public_members`` ``Organization#public_members`` |
61 |
| -``Organization#iter_repos`` ``Organization#repositories`` |
62 |
| -``Organization#iter_teams`` ``Organization#teams`` |
63 |
| -``PullRequest#iter_comments`` ``PullRequest#review_comments`` |
64 |
| -``PullRequest#iter_commits`` ``PullRequest#commits`` |
65 |
| -``PullRequest#iter_files`` ``PullRequest#files`` |
66 |
| -``PullRequest#iter_issue_comments`` ``PullRequest#issue_comments`` |
67 |
| -``Team#iter_members`` ``Team#members`` |
68 |
| -``Team#iter_repos`` ``Team#repositories`` |
69 |
| -``Repository#iter_assignees`` ``Repository#assignees`` |
70 |
| -``Repository#iter_branches`` ``Repository#branches`` |
71 |
| -``Repository#iter_code_frequency`` ``Repository#code_frequency`` |
72 |
| -``Repository#iter_collaborators`` ``Repository#collaborators`` |
73 |
| -``Repository#iter_comments`` ``Repository#comments`` |
74 |
| -``Repository#iter_comments_on_commit`` ``Repository#comments_on_commit`` |
75 |
| -``Repository#iter_commit_activity`` ``Repository#commit_activity`` |
76 |
| -``Repository#iter_commits`` ``Repository#commits`` |
77 |
| -``Repository#iter_contributor_statistics`` ``Repository#contributor_statistics`` |
78 |
| -``Repository#iter_contributors`` ``Repository#contributors`` |
79 |
| -``Repository#iter_forks`` ``Repository#forks`` |
80 |
| -``Repository#iter_hooks`` ``Repository#hooks`` |
81 |
| -``Repository#iter_issues`` ``Repository#issues`` |
82 |
| -``Repository#iter_issue_events`` ``Repository#issue_events`` |
83 |
| -``Repository#iter_keys`` ``Repository#keys`` |
84 |
| -``Repository#iter_labels`` ``Repository#labels`` |
85 |
| -``Repository#iter_languages`` ``Repository#languages`` |
86 |
| -``Repository#iter_milestones`` ``Repository#milestones`` |
87 |
| -``Repository#iter_network_events`` ``Repository#network_events`` |
88 |
| -``Repository#iter_notifications`` ``Repository#notifications`` |
89 |
| -``Repository#iter_pages_builds`` ``Repository#pages_builds`` |
90 |
| -``Repository#iter_pulls`` ``Repository#pull_requests`` |
91 |
| -``Repository#iter_refs`` ``Repository#refs`` |
92 |
| -``Repository#iter_releases`` ``Repository#releases`` |
93 |
| -``Repository#iter_stargazers`` ``Repository#stargazers`` |
94 |
| -``Repository#iter_subscribers`` ``Repository#subscribers`` |
95 |
| -``Repository#iter_statuses`` ``Repository#statuses`` |
96 |
| -``Repository#iter_tags`` ``Repository#tags`` |
97 |
| -``Repository#iter_teams`` ``Repository#teams`` |
98 |
| - |
99 |
| -========================================== ============================================== |
100 |
| - |
101 |
| -- ``github3.login`` has been simplified and split into two functions: |
102 |
| - |
103 |
| - - ``github3.login`` serves the majority use case and only provides an |
104 |
| - authenticated ``GitHub`` object. |
105 |
| - |
106 |
| - - ``github3.enterprise_login`` allows GitHub Enterprise users to log into |
107 |
| - their service. |
108 |
| - |
109 |
| -- ``GitHub#iter_followers`` was split into two functions: |
110 |
| - |
111 |
| - - ``GitHub#followers_of`` which iterates over all of the followers of a user |
112 |
| - whose username you provide |
113 |
| - |
114 |
| - - ``GitHub#followers`` which iterates over all of the followers of the |
115 |
| - authenticated user |
116 |
| - |
117 |
| -- ``GitHub#iter_following`` was split into two functions: |
118 |
| - |
119 |
| - - ``GitHub#followed_by`` which iterates over all of the users followed by |
120 |
| - the username you provide |
121 |
| - |
122 |
| - - ``GitHub#following`` which iterates over all of the users followed by the |
123 |
| - authenticated user |
124 |
| - |
125 |
| -- ``GitHub#iter_gists`` was split into three functions: |
126 |
| - |
127 |
| - - ``GitHub#public_gists`` which iterates over all of the public gists on |
128 |
| - GitHub |
129 |
| - |
130 |
| - - ``GitHub#gists_for`` which iterates over all the public gists of a |
131 |
| - specific user |
132 |
| - |
133 |
| - - ``GitHub#gists`` which iterates over the authenticated users gists |
134 |
| - |
135 |
| -- ``GitHub#iter_orgs`` was split into two functions: |
136 |
| - |
137 |
| - - ``GitHub#organizations`` which iterates over the authenticated user's |
138 |
| - organization memberships |
139 |
| - |
140 |
| - - ``GitHub#organizations_wi
F438
th`` which iterates over the given user's |
141 |
| - organization memberships |
142 |
| - |
143 |
| -- ``GitHub#iter_subscriptions`` was split into two functions: |
144 |
| - |
145 |
| - - ``GitHub#subscriptions_for`` which iterates over an arbitrary user's |
146 |
| - subscriptions |
147 |
| - |
148 |
| - - ``GitHub#subscriptions`` which iterates over the authenticated user's |
149 |
| - subscriptions |
150 |
| - |
151 |
| -- ``GitHub#iter_starred`` was split into two functions: |
152 |
| - |
153 |
| - - ``GitHub#starred_by`` which iterates over an arbitrary user's stars |
154 |
| - |
155 |
| - - ``GitHub#starred`` which iterates over the authenticated user's stars |
156 |
| - |
157 |
| -- Remove legacy watching API: |
158 |
| - |
159 |
| - - ``GitHub#subscribe`` |
160 |
| - |
161 |
| - - ``GitHub#unsubscribe`` |
162 |
| - |
163 |
| - - ``GitHub#is_subscribed`` |
164 |
| - |
165 |
| -- ``Repository#set_subscription`` was split into two simpler functions |
166 |
| - |
167 |
| - - ``Repository#subscribe`` subscribes the authenticated user to the |
168 |
| - repository's notifications |
169 |
| - |
170 |
| - - ``Repository#ignore`` ignores notifications from the repository for the |
171 |
| - authenticated user |
172 |
| - |
173 |
| -- ``Organization#add_repo`` and ``Team#add_repo`` have been renamed to |
174 |
| - ``Organization#add_repository`` and ``Team#add_repository`` respectively. |
175 |
| - |
176 |
| -- ``Organization#create_repo`` has been renamed to |
177 |
| - ``Organization#create_repository``. It no longer accepts ``has_downloads``. |
178 |
| - It now accepts ``license_template``. |
179 |
| - |
180 |
| -- ``Organization#remove_repo`` has been renamed to |
181 |
| - ``Organization#remove_repository``. It now accepts ``team_id`` instead of |
182 |
| - ``team``. |
183 |
| - |
184 |
| -- ``github3.ratelimit_remaining`` was removed |
185 |
| - |
186 |
| -- ``GitHub`` instances can no longer be used as context managers |
187 |
| - |
188 |
| -- The pull request API has changed. |
189 |
| - |
190 |
| - - The ``links`` attribute now contains the raw ``_links`` attribute from the |
191 |
| - API. |
192 |
| - |
193 |
| - - The ``merge_commit_sha`` attribute has been removed since it was deprecated |
194 |
| - in the GitHub API. |
195 |
| - |
196 |
| - - To present a more consistent universal API, certain attributes have been |
197 |
| - renamed. |
198 |
| - |
199 |
| -=============================== ========================== |
200 |
| -Old name New attribute name |
201 |
| -=============================== ========================== |
202 |
| -``PullFile.additions`` ``additions_count`` |
203 |
| -``PullFile.deletions`` ``deletions_count`` |
204 |
| -``PullFile.changes`` ``changes_count`` |
205 |
| -``PullRequest.additions`` ``additions_count`` |
206 |
| -``PullRequest.comments`` ``comments_count`` |
207 |
| -``PullRequest.commits`` ``commits_count`` |
208 |
| -``PullRequest.deletions`` ``deletions_count`` |
209 |
| -``PullRequest.review_comments`` ``review_comments_count`` |
210 |
| -=============================== ========================== |
211 |
| - |
212 |
| -- The Gist API has changed. |
213 |
| - |
214 |
| - - The ``forks`` and ``files`` attributes that used to keep count of the |
215 |
| - number of ``forks`` and ``files`` have been **removed**. |
216 |
| - |
217 |
| - - The ``comments`` attribute which provided the number of comments on a |
218 |
| - gist, has been **renamed** to ``comments_count``. |
219 |
| - |
220 |
| - - The ``is_public`` method has been removed since it just returned the |
221 |
| - ``Gist.public`` attribute. |
222 |
| - |
223 |
| -- Most instances of ``login`` as a parameter have been changed to ``username`` |
224 |
| - for clarity and consistency. This affects the following methods: |
225 |
| - |
226 |
| - - ``Organization#add_member`` |
227 |
| - - ``Organization#is_member`` |
228 |
| - - ``Organization#is_public_member`` |
229 |
| - - ``Organization#remove_member`` |
230 |
| - - ``Repository#add_collaborator`` |
231 |
| - - ``Repository#is_assignee`` |
232 |
| - - ``Repository#is_collaborator`` |
233 |
| - - ``Repository#remove_collaborator`` |
234 |
| - - ``Team#add_member`` |
235 |
| - - ``Team#is_member`` |
236 |
| - |
237 |
| -- ``Repository.stargazers`` is now ``Repository.stargazers_count`` (conforming |
238 |
| - with the attribute name returned by the API). |
239 |
| - |
240 |
| - |
241 |
| -- The ``Issue`` API has changed in order to provide a more consistent attribute |
242 |
| - API. ``Issue.comments`` is now ``Issue.comments_count`` and returns the |
243 |
| - number of comments on an issue. |
244 |
| - |
245 |
| -- The ``Issue.labels`` attribute has also been renamed. It is now available from |
246 |
| - ``Issue.original_labels``. This will provide the user with the list of |
247 |
| - ``Label`` objects that was returned by the API. To retrieve an updated list |
248 |
| - of labels, the user can now use ``Issue#labels``, e.g. |
249 |
| - |
250 |
| - :: |
251 |
| - |
252 |
| - i = github3.issue('sigmavirus24', 'github3.py', 30) |
253 |
| - labels = list(i.labels()) |
254 |
| - |
| 6 | +.. include:: LATEST_VERSION_NOTES.rst |
255 | 7 |
|
256 | 8 | 0.9.0: 2014-05-04
|
257 | 9 | ~~~~~~~~~~~~~~~~~
|
|
0 commit comments