From b77f267749ccd679507cd3db426ca6c310d5098a Mon Sep 17 00:00:00 2001 From: Vincent Jacques Date: Fri, 17 Feb 2012 19:35:02 +0100 Subject: [PATCH] Upload to the Python Package Index --- .gitignore | 2 ++ CheeseShopDescription.rst | 19 +++++++++++++++++++ ReadMe.md | 12 +++++++++--- setup.py | 25 +++++++++++++++++++++++++ 4 files changed, 55 insertions(+), 3 deletions(-) create mode 100644 CheeseShopDescription.rst create mode 100644 setup.py diff --git a/.gitignore b/.gitignore index ba4277037..8a9af1462 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ *.pyc GithubCredentials.py .coverage +/dist +/MANIFEST diff --git a/CheeseShopDescription.rst b/CheeseShopDescription.rst new file mode 100644 index 000000000..cf00c06f3 --- /dev/null +++ b/CheeseShopDescription.rst @@ -0,0 +1,19 @@ +Tutorial +======== + +First create a Gihub instance:: + + from github import Github + + g = Github( "user", "password" ) + +Then play with your Github objects:: + + for repo in g.user().get_repos(): + print repo.name + repo.edit( has_wiki = False ) + +Reference documentation +======================= + +See https://github.com/jacquev6/PyGithub/blob/master/Reference.md diff --git a/ReadMe.md b/ReadMe.md index 781eed258..bfc524f9d 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -1,5 +1,11 @@ This is a Python library to access the [Gitub API v3](http://developer.github.com/v3). +Download and install +==================== + +This package is in the [Python Package Index](http://pypi.python.org/pypi/PyGithub). +You can also clone it on [Github](http://github.com/jacquev6/PyGithub). + Tutorial ======== @@ -11,9 +17,9 @@ First create a Gihub instance: Then play with your Github objects: - for repository in g.user().get_repositories(): - print repository.name - repository.edit( has_wiki = False ) + for repo in g.user().get_repos(): + print repo.name + repo.edit( has_wiki = False ) Reference documentation ======================= diff --git a/setup.py b/setup.py new file mode 100644 index 000000000..c81e5d9ea --- /dev/null +++ b/setup.py @@ -0,0 +1,25 @@ +#!/usr/bin/env python + +from distutils.core import setup + +setup( + name = 'PyGithub', + version = '0.1-beta', + description = 'Use the full Github API v3', + author = 'Vincent Jacques', + author_email = 'vincent@vincent-jacques.net', + url = 'http://github.com/jacquev6/PyGithub', + long_description = open( "CheeseShopDescription.rst" ).read(), + packages = [ + 'github' + ], + classifiers=[ + "Development Status :: 4 - Beta", + "Environment :: Web Environment", + "Intended Audience :: Developers", + "License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)", + "Operating System :: OS Independent", + "Programming Language :: Python", + "Topic :: Software Development", + ], +)