blob: 71f377c502b05b848d90288bf329e503120795b3 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
|
Documentation Overview
=======================
**pygithub3** is a Github APIv3 python wrapper.
You can consume the API with several :doc:`services` (users, repos...) like
you see in `Github API v3 documentation`_.
When you do an API request, **pygithub3** map the result into :doc:`resources`
which can do its own related requests in future releases.
Fast sample
-----------
::
from pygithub3 import Github
gh = Github(login='octocat', password='password')
octocat = gh.users.get() # Auth required
copitux = gh.users.get('copitux')
# copitux = <User (copitux)>
octocat_followers = gh.users.followers.list().all()
copitux_followers = gh.users.followers.list('copitux').all()
# copitux_followers = [<User (ahmontero)>, <User (alazaro)>, ...]
Others
-------
You must apologize my English level. I'm trying to do my best
.. toctree::
:maxdepth: 3
installation
github
services
result
resources
.. _Github API v3 documentation: http://developer.github.com
|
