Skip to main content

Python wrapper for the GitHub API(http://developer.github.com/v3)

Project description

github3.py

Build Status

github3.py is a comprehensive, actively developed and extraordinarily stable wrapper around the GitHub API (v3).

See HISTORY.rst for any “breaking” changes.

Installation

$ pip install github3.py

Dependencies

Testing

License

Modified BSD license

Examples

See the docs for more examples.

Testing

make tests

These coverage numbers are from the old-style tests and still apply to master.

Name                 Stmts   Miss  Cover
----------------------------------------
github3/__init__         8      0   100%
github3/api             54      1    98%
github3/auths           50      0   100%
github3/decorators      27      0   100%
github3/events          89      0   100%
github3/gists          101      0   100%
github3/git             93      0   100%
github3/github         374      0   100%
github3/issues         204      0   100%
github3/legacy          97      0   100%
github3/models         189      0   100%
github3/orgs           177      0   100%
github3/pulls          138      6    96%
github3/repos          790     22    97%
github3/users          160      0   100%
----------------------------------------
TOTAL                 2551     29    99%

Author

Ian Cordasco (sigmavirus24)

Contact Options

  • It is preferred that you send an email to github3.py@librelist.com

  • You may also contact (via email) the author directly with questions/suggestions/comments

History/Changelog

0.2: 2012-11-21

MAJOR API CHANGES:

  • GitHub.iter_subscribed –> GitHub.iter_subscriptions

  • Broken list_* functions in github3.api have been renamed to the correct iter_* methods on GitHub.

  • Removed list_* functions from Repository, Gist, Organization, and User objects

  • Added zen of GitHub method.

  • More tests

  • Changed the way Repository.edit works courtesy of Kristian Glass (@doismellburning)

  • Changed Repository.contents behaviour when acting on a 404.

  • 50% test coverage via mock tests

0.1: 2012-11-13

  • Add API for GitHub Enterprise customers.

0.1b2: 2012-11-10

  • Handle 500 errors better, courtesy of Kristian Glass (@doismellburning)

  • Handle sending json with % symbols better, courtesy of Kristian Glass

  • Correctly handle non-GitHub committers and authors courtesy of Paul Swartz (@paulswartz)

  • Correctly display method signatures in documentatio

0.1b1: 2012-10-31

  • unit tests implemented using mock instead of hitting the GitHub API (#37)

  • removed list_* functions from GitHub object

  • Notifications API coverage

0.1b0: 2012-10-06

  • Support for the complete GitHub API (accomplished)

    • Now also includes the Statuses API

    • Also covers the auto_init parameters to the Repository creation methodology

    • Limited implementation of iterators in the place of list functions.

  • 98% coverage by unit tests

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

github3.py-0.2.tar.gz (49.3 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page