11Pygithub3
22==========
33
4- Pygithub3 is a wrapper to the ` Github API v3 < http://developer.github.com/v3/ >`_ ,
4+ Pygithub3 is a wrapper to the ** Github API v3 ** ,
55written in Python.
66
77It has been developed with extensibility in mind, because the ``API `` is in a
@@ -10,6 +10,10 @@ beta state, trying to achieve a very loosly coupled software.
1010It should be very easy to extend to support new ``requests `` and ``resources ``,
1111because each of them are managed by itself.
1212
13+ `Pygithub3 docs <http://pygithub3.rtfd.org >`_
14+
15+ `Github API v3 docs <http://developer.github.com/v3/ >`_
16+
1317Fast install
1418-------------
1519::
@@ -20,25 +24,15 @@ Fast example
2024-------------
2125::
2226
23- from pygithub3.github import Github
27+ from pygithub3 import Github
2428
25- gh = Github()
26- copitux = gh.users.get('copitux')
27- copitux_followers = gh.users.followers.list('copitux')
28- copitux_followers.all() # lazy iterator that must be consumed
29+ gh = Github(login='copitux', password='password')
2930
30- gh.users.set_credentials(login='github_user', password='github_password')
31- # or: gh.users.set_token('token_code')
32- github_user = gh.users.get()
33- gh.users.followers.set_credentials(login='another_user', password='another_password')
34- another_user_followers = gh.users.followers.list().all()
35- """ Continue...
36- gh.users.emails.set_credentials( ...
37- github_user_emails = gh.users.emails.list()
31+ copitux = gh.users.get()
32+ kennethreitz = gh.users.get('kennethreitz')
3833
39- Each service (users, emails, followers ...) is isolated from the rest. Maybe in
40- future releases the behaviour of Github component changes to share configuration
41- """
34+ copitux_repos = gh.repos.list().all()
35+ kennethreitz_repos = gh.repos.list('kennethreitz').all()
4236
4337Achievements
4438-------------
5044-----
5145
5246- `Repo service <http://developer.github.com/v3/repos/ >`_
53- - Docs
5447
5548Contribute
5649-----------
0 commit comments