Skip to content
This repository

Python library implementing the full Github API v3

README.rst

This is a Python (2 and 3) library to access the Github API v3. With it, you can manage Github resources (repositories, user profiles, organizations, etc.) from Python scripts.

It covers almost the full API (see "What's missing" bellow), and all methods are tested against the real Github site.

Should you have any question, any remark, or if you find a bug, or if there is something you can do with the API but not with PyGithub, please open an issue.

PyGithub 1.x.x is stable and I don't plan to spend time adding missing functionalities. I still accept you pull requests. Here is the references documentation.

I'm currently developing the version 2 of PyGithub. Here is the documentation, including a migration planning.

What's new?

Version 2.0.0-alpha.2 (March 23rd, 2014)

What's now covered by v2:

Please comment on those issues to help me prioritize the next developments. And do not heasitate to open an issue to discuss anything.

Version 1.24.1 (March 16th, 2014)

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

Twitter

I tweet each new release. I rarely tweet, and always about software development, so you might want to follow me to stay informed.

What's missing in versions 1.x.x? Github API v3 URLs not covered by v1

  • /applications/:client_id/tokens/:access_token (GET)
  • /authorizations/clients/:client_id (PUT)
  • /feeds (GET)
  • /meta (GET)
  • /notifications (PUT)
  • /notifications/emails (GET)
  • /notifications/emails (PATCH)
  • /notifications/global/emails (GET)
  • /notifications/global/emails (PUT)
  • /notifications/organization/:org/emails (GET)
  • /notifications/organization/:org/emails (PUT)
  • /notifications/settings (GET)
  • /notifications/settings (PATCH)
  • /notifications/threads/:id (PATCH)
  • /notifications/threads/:id/subscription (DELETE)
  • /notifications/threads/:id/subscription (GET)
  • /notifications/threads/:id/subscription (PUT)
  • /repos/:owner/:repo/contents/:path (DELETE)
  • /repos/:owner/:repo/contents/:path (PUT)
  • /repos/:owner/:repo/notifications (GET)
  • /repos/:owner/:repo/notifications (PUT)
  • /repos/:owner/:repo/releases (GET)
  • /repos/:owner/:repo/releases (POST)
  • /repos/:owner/:repo/releases/:id (DELETE)
  • /repos/:owner/:repo/releases/:id (GET)
  • /repos/:owner/:repo/releases/:id (PATCH)
  • /repos/:owner/:repo/releases/:id/assets (GET)
  • /repos/:owner/:repo/releases/assets/:id (DELETE)
  • /repos/:owner/:repo/releases/assets/:id (GET)
  • /repos/:owner/:repo/releases/assets/:id (PATCH)
  • /repos/:owner/:repo/subscription (DELETE)
  • /repos/:owner/:repo/subscription (GET)
  • /repos/:owner/:repo/subscription (PUT)
Something went wrong with that request. Please try again.