Add a readme and make it appear on pypi.python.org
The python-jenkins page (https://pypi.python.org/pypi/python-jenkins) is pretty bare. This change attempts add info to that page. Change-Id: I90cc12ba337e2e7e52b4ce0f25204c75faff0f22
This commit is contained in:
68
README.rst
Normal file
68
README.rst
Normal file
@@ -0,0 +1,68 @@
|
|||||||
|
==============
|
||||||
|
Python Jenkins
|
||||||
|
==============
|
||||||
|
|
||||||
|
Python Jenkins is a python library that wraps the Jenkins REST interface.
|
||||||
|
We like to use it to automate our Jenkins servers. Here are some of the
|
||||||
|
things you can use it for:
|
||||||
|
|
||||||
|
* Create new jobs
|
||||||
|
* Copy existing jobs
|
||||||
|
* Delete jobs
|
||||||
|
* Update jobs
|
||||||
|
* Get a job's build information
|
||||||
|
* Get Jenkins master version information
|
||||||
|
* Get Jenkins plugin information
|
||||||
|
* Start a build on a job
|
||||||
|
* Create nodes
|
||||||
|
* Enable/Disable nodes
|
||||||
|
* Get information on nodes
|
||||||
|
* and many more..
|
||||||
|
|
||||||
|
To install::
|
||||||
|
|
||||||
|
$ sudo python setup.py install
|
||||||
|
|
||||||
|
Online documentation:
|
||||||
|
|
||||||
|
* http://python-jenkins.readthedocs.org/en/latest/
|
||||||
|
|
||||||
|
Developers
|
||||||
|
==========
|
||||||
|
Bug report:
|
||||||
|
|
||||||
|
* https://bugs.launchpad.net/python-jenkins
|
||||||
|
|
||||||
|
Cloning:
|
||||||
|
|
||||||
|
* https://git.openstack.org/stackforge/python-jenkins
|
||||||
|
|
||||||
|
Patches are submitted via Gerrit at:
|
||||||
|
|
||||||
|
* https://review.openstack.org/
|
||||||
|
|
||||||
|
Please do not submit GitHub pull requests, they will be automatically closed.
|
||||||
|
|
||||||
|
More details on how you can contribute is available on our wiki at:
|
||||||
|
|
||||||
|
* http://wiki.openstack.org/HowToContribute
|
||||||
|
|
||||||
|
Writing a patch
|
||||||
|
===============
|
||||||
|
|
||||||
|
We ask that all code submissions be flake8_ clean. The
|
||||||
|
easiest way to do that is to run tox_ before submitting code for
|
||||||
|
review in Gerrit. It will run ``flake8`` in the same
|
||||||
|
manner as the automated test suite that will run on proposed
|
||||||
|
patchsets.
|
||||||
|
|
||||||
|
Installing without setup.py
|
||||||
|
===========================
|
||||||
|
|
||||||
|
Then install the required python packages using pip_::
|
||||||
|
|
||||||
|
$ sudo pip install python-jenkins
|
||||||
|
|
||||||
|
.. _flake8: https://pypi.python.org/pypi/flake8
|
||||||
|
.. _tox: https://testrun.org/tox
|
||||||
|
.. _pip: https://pypi.python.org/pypi/pip
|
10
setup.cfg
10
setup.cfg
@@ -2,9 +2,10 @@
|
|||||||
name = python-jenkins
|
name = python-jenkins
|
||||||
author = Ken Conley
|
author = Ken Conley
|
||||||
author_email = kwc@willowgarage.com
|
author_email = kwc@willowgarage.com
|
||||||
maintainer = OpenStack
|
summary = Python bindings for the remote Jenkins API
|
||||||
|
maintainer = OpenStack Infrastructure Team
|
||||||
maintainer_email = openstack@lists.launchpad.net
|
maintainer_email = openstack@lists.launchpad.net
|
||||||
description = Python bindings for the remote Jenkins API
|
description-file = README.rst
|
||||||
license = BSD
|
license = BSD
|
||||||
home-page = http://git.openstack.org/cgit/stackforge/python-jenkins
|
home-page = http://git.openstack.org/cgit/stackforge/python-jenkins
|
||||||
classifiers =
|
classifiers =
|
||||||
@@ -14,6 +15,11 @@ classifiers =
|
|||||||
License :: OSI Approved :: BSD License
|
License :: OSI Approved :: BSD License
|
||||||
Operating System :: OS Independent
|
Operating System :: OS Independent
|
||||||
Programming Language :: Python
|
Programming Language :: Python
|
||||||
|
Programming Language :: Python :: 2
|
||||||
|
Programming Language :: Python :: 2.6
|
||||||
|
Programming Language :: Python :: 2.7
|
||||||
|
Programming Language :: Python :: 3
|
||||||
|
Programming Language :: Python :: 3.3
|
||||||
|
|
||||||
[files]
|
[files]
|
||||||
packages =
|
packages =
|
||||||
|
Reference in New Issue
Block a user