From: Salim Fadhley Date: Thu, 5 Jan 2012 22:42:57 +0000 (+0000) Subject: Tidy ups of the setup & readme files. X-Git-Tag: v0.2.23~338 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=1dd58d4fa02f4b7c1cc79b374a1ac3e08a75d60b;p=tools%2Fpython-jenkinsapi.git Tidy ups of the setup & readme files. --- diff --git a/README b/README index 5fbd692..041f02f 100644 --- a/README +++ b/README @@ -1,22 +1,37 @@ -The original project is pyjenkinsci on googlecode: http://pyjenkinsci.googlecode.com/ +== About this library == -A number of refactoring has been done: - * uniform usage of jenkins instead of mixed jenkins/hudson - * import fixup, all imports are relative to packagename now - * downloading artifacts is simplified +Jenkins is the market leading continuous integration system, originally created by Kohsuke Kawaguchi. This API makes Jenkins even easier to use by providing an easy to use conventional python interface. -New features: +Jenkins (and It's predecessor Hudson) are fantastic projects - but they are somewhat Java-centric. Thankfully the designers have provided an excellent and complete REST interface. This library wraps up that interface as more conventional python objects in order to make most Jenkins oriented tasks simpler. + +This library can help you: + + * Query the test-results of a completed build + * Get a objects representing the latest builds of a job + * Search for artefacts by simple criteria + * Block until jobs are complete + * Install artefacts to custom-specified directory structures * username/password auth support for jenkins instances with auth turned on + * Ability to search for builds by subversion revision * Ability to add/remove/query jenkins slaves - * Ability to retrieve/find builds by subversion revision -Deletion: +== Installing JenkinsAPI === + +Egg-files for this project are hosted on PyPi. Most Python users should be able to use pip or distribute to automatically install this project. + +Most users can do the following: + +easy_install jenkinsapi + +If you'd like to install in multi-version mode: + +easy_install -m jenkinsapi -I've completely removed the test methods and the small amount of test cases -All tests were tied to a specific local environment. +== Project Authors == -Thanx to salimfadhley@gmail.com for the initial version which we based this on -Thanx to ruslan@hyves.nl for the subversion revision patches + * Salim Fadhley (sal@stodgge.org) - Project founder + * Ramon van Alteren (ramon@vanaleren.nl) - Significant refactoring, code-quality improvement & support for Jenkins authentication + * ruslan@hyves.nl - Subversion revision patches -Current code lives on github: https://github.com/ramonvanalteren/jenkinsapi.git +Current code lives on github: https://github.com/salimfadhley/jenkinsapi diff --git a/setup.py b/setup.py index eb10d03..355c8c9 100644 --- a/setup.py +++ b/setup.py @@ -1,4 +1,11 @@ from setuptools import setup, find_packages +import sys, os + +# Use the README file as the long-description for the project. +# This makes sure that the PyPi index page contains automatically +# generated documentation. +PROJECT_ROOT, _ = os.path.split(sys.argv[0]) +DESCRIPTION = open( os.path.join(PROJECT_ROOT, "README") ).read() GLOBAL_ENTRY_POINTS = { "console_scripts":[ "jenkins_invoke=jenkinsapi.command_line.jenkins_invoke:main"] @@ -6,12 +13,13 @@ GLOBAL_ENTRY_POINTS = { setup(name='jenkinsapi', version='0.1', - description='A Python API for accessing resources on a Jenkins continuous-integration server.', - author="Ramon van Alteren, Salim Fadhley", - author_email='ramon@vanalteren.nl, salimfadhley@gmail.com', + author="Salim Fadhley, Ramon van Alteren", + author_email='salimfadhley@gmail.com, ramon@vanalteren.nl', packages=find_packages('.'), zip_safe=True, include_package_data = False, entry_points = GLOBAL_ENTRY_POINTS, - url="https://github.com/ramonvanalteren/jenkinsapi", + url="https://github.com/salimfadhley/jenkinsapi", + description='A Python API for accessing resources on a Jenkins continuous-integration server.', + long_description=DESCRIPTION, )