mirror of
https://github.com/status-im/PyGithub.git
synced 2026-09-01 19:31:10 +00:00
Vincent Jacques
8a2624e3a1
Conflicts: github/Issue.py github/MainClass.py github/PaginatedList.py github/Repository.py github/Requester.py
70 lines
3.0 KiB
ReStructuredText
70 lines
3.0 KiB
ReStructuredText
This is a Python (2 and 3) library to access the `Github API v3 <http://developer.github.com/v3>`_.
|
|
With it, you can manage your `Github <http://github.com>`_ resources (repositories, user profiles, organizations, etc.) from Python scripts.
|
|
|
|
It covers the **full** API (except recent additions, 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 <https://github.com/jacquev6/PyGithub/issues>`_.
|
|
|
|
PyGithub is stable. I will maintain it up to date with the API, and fix bugs if any, but I don't plan new heavy developments.
|
|
|
|
What's new?
|
|
===========
|
|
|
|
`Version 1.19.0 <https://github.com/jacquev6/PyGithub/issues?milestone=31&state=closed>`_ (?? ??th, 2013)
|
|
|
|
* Implement ``Github.get_repos`` to get all public repositories
|
|
* Implement ``NamedUser.has_in_following``
|
|
* Technical change: HTTP headers are now stored in retrieved objects. This is a base for new functionalities. Thank you `akfish <https://github.com/akfish>`_ for the pull request
|
|
* Use the new URL to fork gists (minor change)
|
|
* Use the new URL to test hooks (minor change)
|
|
|
|
What's missing?
|
|
===============
|
|
|
|
We now have automated ways to list URLs documented in `the reference of Github API v3 <http://developer.github.com>`_ and not covered by PyGithub.
|
|
|
|
Github API v3 URLs not (yet) covered by PyGithub
|
|
------------------------------------------------
|
|
|
|
* ``/applications/:client_id/tokens/:access_token`` (GET)
|
|
* ``/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)
|
|
* ``/rate_limit`` (GET)
|
|
|
|
* should be called in method ``Github.get_rate_limit``. See also ``Github.rate_limiting``
|
|
|
|
* ``/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/stats/code_frequency`` (GET)
|
|
* ``/repos/:owner/:repo/stats/commit_activity`` (GET)
|
|
* ``/repos/:owner/:repo/stats/contributors`` (GET)
|
|
* ``/repos/:owner/:repo/stats/participation`` (GET)
|
|
* ``/repos/:owner/:repo/stats/punch_card`` (GET)
|
|
* ``/repos/:owner/:repo/subscription`` (DELETE)
|
|
* ``/repos/:owner/:repo/subscription`` (GET)
|
|
* ``/repos/:owner/:repo/subscription`` (PUT)
|
|
* ``/search/code`` (GET)
|
|
* ``/search/issues`` (GET)
|
|
* ``/search/repositories`` (GET)
|
|
* ``/search/users`` (GET)
|
|
|
|
Documentation
|
|
=============
|
|
|
|
All the documentation is here: http://jacquev6.github.com/PyGithub.
|