Change log

Stable versions

Version 1.25.2 (October 7th, 2014)

Version 1.25.1 (September 28th, 2014)

  • Fix two-factor authentication header, thanks to tradej for the pull request

Version 1.25.0 (May 4th, 2014)

Version 1.24.1 (March 16th, 2014)

  • Fix urlquoting in search, thanks to cro for the pull request

Version 1.24.0 (March 2nd, 2014)

Version 1.23.0 (December 23th, 2013)

  • Fix all that is based on headers in Python 3 (pagination, conditional request, rate_limit...), huge thanks to cwarren-mw for finding the bug
  • Accept strings for assignees and collaborators, thanks to farrd
  • Ease two-factor authentication by adding ‘onetime_password’ to AuthenticatedUser.create_authorization, thanks to cameronbwhite

Version 1.22.0 (December 15th, 2013)

Version 1.21.0 (November ??th, 2013)

  • Accept strings as well as Label objects in Issue.add_to_labels, Issue.remove_from_labels and Issue.set_labels. Thank you acdha for asking
  • Implement equality comparison for completable github objects (ie. those who have a url attribute). Warning, comparison is still not implemented for non-completable objects. This will be done in version 2.0 of PyGithub. Thank you OddBloke for asking
  • Add parameter author to Repository.get_commits. Thank you naorrosenberg for asking
  • Implement the statistics end points. Thank you naorrosenberg for asking

Version 1.20.0 (October 20th, 2013) (First Seattle edition)

  • Implement Github.get_hook(name). Thank you klmitch for asking
  • In case bad data is returned by Github API v3, raise an exception only when the user accesses the faulty attribute, not when constructing the object containing this attribute. Thank you klmitch for asking
  • Fix parameter public/private of Repository.edit. Thank you daireobroin449 for reporting the issue
  • Remove Repository.create_download and NamedUser.create_gist as the corrensponding APIs are not documented anymore

Version 1.19.0 (September 8th, 2013) (AKFish’s edition)

  • Implement conditional requests by the method GithubObject.update. Thank you very much akfish for the pull request and your collaboration!
  • Implement persistence of PyGithub objects: Github.save and Github.load. Don’t forget to update your objects after loading them, it won’t decrease your rate limiting quota if nothing has changed. Again, thank you akfish
  • Implement Github.get_repos to get all public repositories
  • Implement NamedUser.has_in_following
  • Implement Github.get_api_status, Github.get_last_api_status_message and Github.get_api_status_messages. Thank you ruxandraburtica for asking
  • Implement Github.get_rate_limit
  • Add many missing attributes
  • Technical change: HTTP headers are now stored in retrieved objects. This is a base for new functionalities. Thank you akfish for the pull request
  • Use the new URL to fork gists (minor change)
  • Use the new URL to test hooks (minor change)

Version 1.18.0 (August 21st, 2013) (Bénodet edition)

  • Issuesrepository attribute will never be None. Thank you stuglaser for the pull request
  • No more false assumption on rate_limiting, and creation of rate_limiting_resettime. Thank you edjackson for the pull request
  • New parameters since and until to Repository.get_commits. Thank you apetresc for the pull request
  • Catch Json parsing exception for some internal server errors, and throw a better exception. Thank you MarkRoddy for the pull request
  • Allow reversed iteration of PaginatedList. Thank you davidbrai for the pull request

Version 1.17.0 (Jully 7th, 2013) (Hamburg edition)

Version 1.16.0 (May 31th, 2013) (Concarneau edition)

  • Add the html_url attribute to IssueComment and PullRequestComment

Version 1.15.0 (May 17th, 2013) (Switzerland edition)

  • Implement listing of user issues with all parameters. Thank you Daehyok Shin for reporting
  • Raise two new specific exceptions

Version 1.14.2 (April 25th, 2013)

  • Fix paginated requests when using secret-key oauth. Thank you jseabold for analysing the bug

Version 1.14.1 (April 25th, 2013)

Version 1.14.0 (April 22nd, 2013)

  • Improve gist edition. Thank you jasonwiener for asking:
    • Delete a file with gist.edit(files={"name.txt": None})
    • Rename a file with gist.edit(files={"old_name.txt": github.InputFileContent(gist.files["old_name.txt"].content, new_name="new_name.txt")})
  • Raise specific exceptions. Thank you pconrad for giving me the idea

Version 1.13.1 (March 28nd, 2013)

Version 1.13.0 (March 22nd, 2013)

Version 1.12.2 (March 3rd, 2013)

  • Fix major issue with Python 3: Json decoding was broken. Thank you bilderbuchi for reporting

Version 1.12.1 (February 20th, 2013)

  • Nothing, but packaging/upload of 1.12.0 failed

Version 1.11.1 (February 9th, 2013) (London edition)

  • Fix bug in lazy completion. Thank you ianozsvald for pinpointing it

Version 1.10.0 (December 25th, 2012) (Christmas 2012 edition)

Version 1.9.1 (November 20th, 2012)

  • Fix an assertion failure when integers returned by Github do not fit in a Python int

Version 1.9.0 (November 19th, 2012)

  • You can now use your client_id and client_secret to increase rate limiting without authentication
  • You can now send a custom User-Agent
  • PullRequest now has its ‘assignee’ attribute, thank you mstead
  • Repository.edit now has ‘default_branch’ parameter
  • create_repo has ‘auto_init’ and ‘gitignore_template’ parameters
  • GistComment URL is changed (see http://developer.github.com/changes/2012-10-31-gist-comment-uris)
  • A typo in the readme was fixed by tymofij, thank you
  • Internal stuff:
    • Add encoding comment to Python files, thank you Zearin
    • Restore support of Python 2.5
    • Restore coverage measurement in setup.py test
    • Small refactoring

Version 1.8.1 (October 28th, 2012)

  • Repository.get_git_ref prepends “refs/” to the requested references. Thank you simon-weber for noting the incoherence between documentation and behavior. If you feel like it’s a breaking change, please see this issue

Version 1.8.0 (September 30th, 2012)

  • Enable Travis CI
  • Fix error 500 when json payload contains percent character (%). Thank you again quixotique for pointing that and reporting it to Github
  • Enable debug logging. Logger name is “github”. Simple logging can be enabled by github.enable_console_debug_logging(). Thank you quixotique for the merge request and the advice
  • Publish tests in the PyPi source archive to ease QA tests of the FreeBSD port. Thank you koobs for maintaining this port
  • Switch to Semantic Versioning
  • Respect pep8 Style Guide for Python Code

Version 1.7 (September 12th, 2012)

  • Be able to clear the assignee and the milestone of an Issue. Thank you quixotique for the merge request
  • Fix an AssertionFailure in Organization.get_xxx when using Github Enterprise. Thank you mnsanghvi for pointing that
  • Expose pagination to users needing it (PaginatedList.get_page). Thank you kukuts for asking
  • Improve handling of legacy search APIs
  • Small refactoring (documentation, removal of old code generation artifacts)

Version 1.6 (September 8th, 2012)

Version 1.5 (September 5th, 2012)

  • Add a timeout option, thank you much xobb1t for the merge request. This drops Python 2.5 support. I may be able to restore it in next version.
  • Implement Repository.delete, thank you pmchen for asking

Version 1.4 (August 4th, 2012)

  • Allow connection to a custom Github URL, for Github Enterprise, thank you very much engie for the merge request

Version 1.3 (July 13th, 2012)

  • Implement markdown rendering
  • GitAuthor.date is now a datetime, thank you bilderbuchi
  • Fix documentation of Github.get_gist: id is a string, not an integer

Version 1.2 (June 29th, 2012)

  • Implement legacy search APIs, thank you kukuts for telling me Github had released them
  • Fix a bug with issue labels containing spaces, thank you philipkimmey for detecting the bug and fixing it
  • Clarify how collections of objects are returned by get_* methods, thank you bilderbuchi for asking

Version 1.1 (June 20th, 2012)

  • Restore compatibility with Python 2.5, thank you pmuilu
  • Use package_data instead of data_files for documentation files in setup.py, thank you malexw for reporting

Version 1.0 (June 3rd, 2012)

  • Complete rewrite, with no more complicated meta-description
  • Full typing of attributes and parameters
  • Full documentation of attributes and parameters
  • More usable exceptions raised in case on problems with the API
  • Some bugs and limitations fixed, special thanks to bilderbuchi, roskakori and tallforasmurf for reporting them!

Pre-release versions

Version 0.7 (May 26th, 2012)

  • Use PyGithub with OAuth authentication or with no authentication at all

Version 0.6 (April 17th, 2012)

  • Fix issue 21 (KeyError when accessing repositories)
  • Re-completed the API with NamedUser.create_gist

Version 0.5 (March 19th, 2012)

  • Major achievement: all APIs are implemented
  • More refactoring, of course

Version 0.4 (March 12th, 2012)

  • The list of the not implemented APIs is shorter than the list of the implemented APIs
  • APIs not implemented:
    • GET /gists/public
    • GET /issues
    • GET /repos/:owner/:repo/compare/:base...:head
    • GET /repos/:owner/:repo/git/trees/:sha?recursive-1
    • POST /repos/:owner/:repo/git/trees?base_tree-
  • Gists
  • Autorizations
  • Keys
  • Hooks
  • Events
  • Merge pull requests
  • More refactoring, one more time

Version 0.3 (February 26th, 2012)

  • More refactoring
  • Issues, milestones and their labels
  • NamedUser:
    • emails
  • Repository:
    • downloads
    • tags, branches, commits and comments (not the same as “Git objects” of version 0.2)
    • pull requests (no automatic merge yet)
  • Automatic generation of the reference documentation of classes, with less “see API”s, and less errors

Version 0.2 (February 23rd, 2012)

  • Refactoring
  • Teams details and modification
    • basic attributes
    • list teams in organizations, on repositories
  • Git objects
    • create and get tags, references, commits, trees, blobs
    • list and edit references

Version 0.1 (February 19th, 2012)

  • User details and modification
    • basic attributes
    • followers, following, watching
    • organizations
    • repositories
  • Repository details and modification
    • basic attributes
    • forking
    • collaborators, contributors, watchers
  • Organization details and modification
    • basic attributes
    • members and public members