README
======
Python Jenkins is a python wrapper for the `Jenkins <http://jenkins-ci.org/>`_
REST API which aims to provide a more conventionally pythonic way of controlling
a Jenkins server. It provides a higher-level API containing a number of
convenience functions.
We like to use python-jenkins 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
* Create/delete/reconfig views
* Put server in shutdown mode (quiet down)
* List running builds
* Delete builds
* Wipeout job workspace
* Create/delete/update folders [#f1]_
* Set the next build number [#f2]_
* Install plugins
* 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
Repository:
* https://git.openstack.org/cgit/openstack/python-jenkins
Cloning:
* git clone https://git.openstack.org/openstack/python-jenkins
Patches are submitted via Gerrit at:
* https://review.openstack.org/
Please do not submit GitHub pull requests, they will be automatically closed.
The python-jenkins developers communicate in the ``#openstack-jjb`` channel
on Freenode's IRC network.
More details on how you can contribute is available on our wiki at:
* http://docs.openstack.org/infra/manual/developers.html
Writing a patch
---------------
Be sure that you lint code before created an code review.
The easiest way to do this is to install git pre-commit_ hooks.
Installing without setup.py
---------------------------
Then install the required python packages using pip_::
$ sudo pip install python-jenkins
.. _tox: https://testrun.org/tox
.. _pip: https://pypi.org/project/pip
.. _pre-commit: https://pre-commit.com/#install
.. rubric:: Footnotes
.. [#f1] The free `Cloudbees Folders Plugin
<https://wiki.jenkins-ci.org/display/JENKINS/CloudBees+Folders+Plugin>`_
provides support for a subset of the full folders functionality. For the
complete capabilities you will need the paid for version of the plugin.
.. [#f2] The `Next Build Number Plugin
<https://wiki.jenkins-ci.org/display/JENKINS/Next+Build+Number+Plugin>`_
provides support for setting the next build number.
Raw data
{
"_id": null,
"home_page": "http://git.openstack.org/cgit/openstack/python-jenkins",
"name": "yb-python-jenkins",
"maintainer": "OpenStack Infrastructure Team",
"docs_url": null,
"requires_python": "",
"maintainer_email": "openstack@lists.launchpad.net",
"keywords": "",
"author": "Ken Conley",
"author_email": "kwc@willowgarage.com",
"download_url": "https://files.pythonhosted.org/packages/46/0a/17490c676292652b9d53a102c42a9c9e812fdedbe10b9eb219ffb3c028e0/yb-python-jenkins-1.7.1003.tar.gz",
"platform": null,
"description": "README\n======\n\nPython Jenkins is a python wrapper for the `Jenkins <http://jenkins-ci.org/>`_\nREST API which aims to provide a more conventionally pythonic way of controlling\na Jenkins server. It provides a higher-level API containing a number of\nconvenience functions.\n\nWe like to use python-jenkins to automate our Jenkins servers. Here are some of\nthe things you can use it for:\n\n* Create new jobs\n* Copy existing jobs\n* Delete jobs\n* Update jobs\n* Get a job's build information\n* Get Jenkins master version information\n* Get Jenkins plugin information\n* Start a build on a job\n* Create nodes\n* Enable/Disable nodes\n* Get information on nodes\n* Create/delete/reconfig views\n* Put server in shutdown mode (quiet down)\n* List running builds\n* Delete builds\n* Wipeout job workspace\n* Create/delete/update folders [#f1]_\n* Set the next build number [#f2]_\n* Install plugins\n* and many more..\n\nTo install::\n\n $ sudo python setup.py install\n\nOnline documentation:\n\n* http://python-jenkins.readthedocs.org/en/latest/\n\nDevelopers\n----------\nBug report:\n\n* https://bugs.launchpad.net/python-jenkins\n\nRepository:\n\n* https://git.openstack.org/cgit/openstack/python-jenkins\n\nCloning:\n\n* git clone https://git.openstack.org/openstack/python-jenkins\n\nPatches are submitted via Gerrit at:\n\n* https://review.openstack.org/\n\nPlease do not submit GitHub pull requests, they will be automatically closed.\n\nThe python-jenkins developers communicate in the ``#openstack-jjb`` channel\non Freenode's IRC network.\n\nMore details on how you can contribute is available on our wiki at:\n\n* http://docs.openstack.org/infra/manual/developers.html\n\nWriting a patch\n---------------\n\nBe sure that you lint code before created an code review.\nThe easiest way to do this is to install git pre-commit_ hooks.\n\nInstalling without setup.py\n---------------------------\n\nThen install the required python packages using pip_::\n\n $ sudo pip install python-jenkins\n\n.. _tox: https://testrun.org/tox\n.. _pip: https://pypi.org/project/pip\n.. _pre-commit: https://pre-commit.com/#install\n\n\n.. rubric:: Footnotes\n\n.. [#f1] The free `Cloudbees Folders Plugin\n <https://wiki.jenkins-ci.org/display/JENKINS/CloudBees+Folders+Plugin>`_\n provides support for a subset of the full folders functionality. For the\n complete capabilities you will need the paid for version of the plugin.\n\n.. [#f2] The `Next Build Number Plugin\n <https://wiki.jenkins-ci.org/display/JENKINS/Next+Build+Number+Plugin>`_\n provides support for setting the next build number.",
"bugtrack_url": null,
"license": "BSD",
"summary": "Python bindings for the remote Jenkins API",
"version": "1.7.1003",
"project_urls": {
"Homepage": "http://git.openstack.org/cgit/openstack/python-jenkins"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "460a17490c676292652b9d53a102c42a9c9e812fdedbe10b9eb219ffb3c028e0",
"md5": "3da1891660a94c4f5e0dae83bde27d1f",
"sha256": "272416aaa790c66c86cfb3ddaa79f117dad6f1c51989ae4ab3188ca702a4322e"
},
"downloads": -1,
"filename": "yb-python-jenkins-1.7.1003.tar.gz",
"has_sig": false,
"md5_digest": "3da1891660a94c4f5e0dae83bde27d1f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 64737,
"upload_time": "2023-08-29T22:25:58",
"upload_time_iso_8601": "2023-08-29T22:25:58.905659Z",
"url": "https://files.pythonhosted.org/packages/46/0a/17490c676292652b9d53a102c42a9c9e812fdedbe10b9eb219ffb3c028e0/yb-python-jenkins-1.7.1003.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-29 22:25:58",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "yb-python-jenkins"
}
JSON