diff options
| -rw-r--r-- | AUTHORS.rst | 2 | ||||
| -rw-r--r-- | README.rst | 29 | ||||
| -rw-r--r-- | docs/conf.py | 8 | ||||
| -rw-r--r-- | pygithub3/__init__.py | 2 | ||||
| -rw-r--r-- | setup.py | 2 |
5 files changed, 20 insertions, 23 deletions
diff --git a/AUTHORS.rst b/AUTHORS.rst index 866c7cc..af05118 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -5,7 +5,6 @@ Development Lead ================= - David Medina <davidmedina9@gmail.com> -- Francisco Marcos <fmarcos83@gmail.com> Forked and redesign from Kenneth Reitz's repo ---------------------------------------------- @@ -21,3 +20,4 @@ Patches and Suggestions - Mahdi Yusuf - Rok Garbas - Antti Kaihola <akaihol+github@ambitone.com> +- Francisco Marcos <fmarcos83@gmail.com> @@ -1,7 +1,7 @@ Pygithub3 ========== -Pygithub3 is a wrapper to the `Github API v3 <http://developer.github.com/v3/>`_, +Pygithub3 is a wrapper to the **Github API v3**, written in Python. It 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. It should be very easy to extend to support new ``requests`` and ``resources``, because each of them are managed by itself. +`Pygithub3 docs <http://pygithub3.rtfd.org>`_ + +`Github API v3 docs <http://developer.github.com/v3/>`_ + Fast install ------------- :: @@ -20,25 +24,15 @@ Fast example ------------- :: - from pygithub3.github import Github + from pygithub3 import Github - gh = Github() - copitux = gh.users.get('copitux') - copitux_followers = gh.users.followers.list('copitux') - copitux_followers.all() # lazy iterator that must be consumed + gh = Github(login='copitux', password='password') - gh.users.set_credentials(login='github_user', password='github_password') - # or: gh.users.set_token('token_code') - github_user = gh.users.get() - gh.users.followers.set_credentials(login='another_user', password='another_password') - another_user_followers = gh.users.followers.list().all() - """ Continue... - gh.users.emails.set_credentials( ... - github_user_emails = gh.users.emails.list() + copitux = gh.users.get() + kennethreitz = gh.users.get('kennethreitz') - Each service (users, emails, followers ...) is isolated from the rest. Maybe in - future releases the behaviour of Github component changes to share configuration - """ + copitux_repos = gh.repos.list().all() + kennethreitz_repos = gh.repos.list('kennethreitz').all() Achievements ------------- @@ -50,7 +44,6 @@ TODO ----- - `Repo service <http://developer.github.com/v3/repos/>`_ -- Docs Contribute ----------- diff --git a/docs/conf.py b/docs/conf.py index 7b87720..c10f5c0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -49,9 +49,13 @@ copyright = u'2012, David Medina' # built documents. # # The short X.Y version. -version = '0.2' +try: + from pygithub3 import __version__ +except: + __version__ = 'dev' +version = __version__ # The full version, including alpha/beta/rc tags. -release = '0.2' +release = __version__ # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/pygithub3/__init__.py b/pygithub3/__init__.py index 1e9d3e1..ecab597 100644 --- a/pygithub3/__init__.py +++ b/pygithub3/__init__.py @@ -2,7 +2,7 @@ # -*- encoding: utf-8 -*- __title__ = 'pygithub3' -__version__ = '0.1' +__version__ = '0.1.9' __author__ = 'David Medina' __email__ = 'davidmedina9@gmail.com' __license__ = 'ISC' @@ -23,7 +23,7 @@ setup( 'Programming Language :: Python :: 2.7', 'License :: OSI Approved :: ISC License (ISCL)', 'Operating System :: OS Independent', - 'Development Status :: 1 - Planning', + 'Development Status :: 3 - Alpha', 'Intended Audience :: Developers', ), ) |