github3.py 1.0.0a1

Breaking Changes

• Organization#add_member has been changed. The second parameter has been changed to team_id and now expects an integer.

• Organization#add_repository has been changed. The second parameter has been changed to team_id and now expects an integer.

• All methods and functions starting with iter_ have been renamed.

• github3.login has been simplified and split into two functions:

  • github3.login serves the majority use case and only provides an authenticated GitHub object.

  • github3.enterprise_login allows GitHub Enterprise users to log into their service.

• GitHub#iter_followers was split into two functions:

  • GitHub#followers_of which iterates over all of the followers of a user whose username you provide

  • GitHub#followers which iterates over all of the followers of the authenticated user

• GitHub#iter_following was split into two functions:

  • GitHub#followed_by which iterates over all of the users followed by the username you provide

  • GitHub#following which iterates over all of the users followed by the authenticated user

• GitHub#iter_gists was split into three functions:

  • GitHub#public_gists which iterates over all of the public gists on GitHub

  • GitHub#gists_for which iterates over all the public gists of a specific user

  • GitHub#gists which iterates over the authenticated users gists

• GitHub#iter_orgs was split into two functions:

  • GitHub#organizations which iterates over the authenticated user’s organization memberships

  • GitHub#organizations_with which iterates over the given user’s organization memberships

• GitHub#iter_subscriptions was split into two functions:

  • GitHub#subscriptions_for which iterates over an arbitrary user’s subscriptions

  • GitHub#subscriptions which iterates over the authenticated user’s subscriptions

• GitHub#iter_starred was split into two functions:

  • GitHub#starred_by which iterates over an arbitrary user’s stars

  • GitHub#starred which iterates over the authenticated user’s stars

• GitHub#user was split into two functions:

  • GitHub#user which retrieves an arbitrary user’s information

  • GitHub#me which retrieves the authenticated user’s information

• GitHub#update_user has been renamed to GitHub#update_me and only uses 1 API call now. It was renamed to reflect the addition of GitHub#me.

• The legacy watching API has been removed:

  • GitHub#subscribe

  • GitHub#unsubscribe

  • GitHub#is_subscribed

• GitHub#create_repo was renamed to GitHub#create_repository

• GitHub#delete_key was removed. To delete a key retrieve it with GitHub#key and then call Key#delete.

• Repository#set_subscription was split into two simpler functions

  • Repository#subscribe subscribes the authenticated user to the repository’s notifications

  • Repository#ignore ignores notifications from the repository for the authenticated user

• Repository#contents was split into two simpler functions

  • Repository#file_contents returns the contents of a file object

  • Repository#directory_contents returns the contents of files in a directory.

• Organization#add_repo and Team#add_repo have been renamed to Organization#add_repository and Team#add_repository respectively.

• Organization#create_repo has been renamed to Organization#create_repository. It no longer accepts has_downloads. It now accepts license_template.

• Organization#remove_repo has been renamed to Organization#remove_repository. It now accepts team_id instead of team.

• github3.ratelimit_remaining was removed

• GitHub instances can no longer be used as context managers

• The pull request API has changed.

  • The links attribute now contains the raw _links attribute from the API.

  • The merge_commit_sha attribute has been removed since it was deprecated in the GitHub API.

  • To present a more consistent universal API, certain attributes have been renamed.

• The Gist API has changed.

  • The forks and files attributes that used to keep count of the number of forks and files have been removed.

  • The comments attribute which provided the number of comments on a gist, has been renamed to comments_count.

  • The is_public method has been removed since it just returned the Gist.public attribute.

• Most instances of login as a parameter have been changed to username for clarity and consistency. This affects the following methods:

  • github3.authorize

  • github3.repositories_by

  • github3.user

  • GitHub

  • GitHub#authorize

  • GitHub#follow

  • GitHub#is_following

  • GitHub#is_starred

  • GitHub#issue

  • GitHub#followers_of

  • GitHub#followed_by

  • GitHub#gists_by

  • GitHub#issues_on

  • GitHub#organizations_with

  • GitHub#starred_by

  • GitHub#subscriptions_for

  • GitHub#user

  • GitHubEnterprise

  • Issue#assign

  • Organization#add_member

  • Organization#is_member

  • Organization#is_public_member

  • Organization#remove_member

  • Repository#add_collaborator

  • Repository#is_assignee

  • Repository#is_collaborator

  • Repository#remove_collaborator

  • Team#add_member

  • Team#is_member

  • User#is_assignee_on

  • User#is_following

• Repository.stargazers is now Repository.stargazers_count (conforming with the attribute name returned by the API).

• The Issue API has changed in order to provide a more consistent attribute API. Issue.comments is now Issue.comments_count and returns the number of comments on an issue.

• The Issue.labels attribute has also been renamed. It is now available from Issue.original_labels. This will provide the user with the list of Label objects that was returned by the API. To retrieve an updated list of labels, the user can now use Issue#labels, e.g.

  i = github3.issue('sigmavirus24', 'github3.py', 30)
  labels = list(i.labels())

• The Organization and User APIs have changed to become more consistent with the rest of the library and GitHub API. The following attribute names have been changed

• The Release.assets attribute has been renamed to Release.original_assets. To retrieve up-to-date assets, use the Release#assets method.

• The Authorization API has changed. The update method has been split into three methods: add_scopes, remove_scopes, replace_scopes. This highlights the fact that Authorization#update used to require more than one request.

• Event#is_public has been removed. Simply check the event’s public attribute instead.

• Repository#delete_file and Repository#update_file have been removed. Simply delete or update a file using the Contents API.

• Content#delete now returns a dictionary that matches the JSON returned by the API. It contains the Contents and the Commit associated with the deletion.

• Content#update now returns a dictionary that matches the JSON returned by the API. It contains the Contents and the Commit associated with the deletion.

• Issue.pull_request has been renamed to Issue.pull_request_urls

New Features

• Most objects now have a session attribute. This is a subclass of a Session object from requests. This can now be used in conjunction with a third-party caching mechanism. The suggested caching library is cachecontrol.

• All object’s url attribute are now available.

• You can now retrieve a repository by its id with GitHub#repository_with_id.

• You can call the pull_request method on an Issue now to retrieve the associated pull request:

  import github3
  
  i = github3.issue('sigmavirus24', 'github3.py', 301)
  pr = i.pull_request()