{ "info": { "author": "Joao Cravo", "author_email": "joaogbcravo@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Environment :: Plugins", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python :: 2.7", "Topic :: Software Development :: Libraries" ], "description": "gocdapi\n==========\n\n.. image:: https://badge.fury.io/py/gocdapi.png\n :target: http://badge.fury.io/py/gocdapi\n\n.. image:: https://travis-ci.org/joaogbcravo/gocdapi.png?branch=master\n :target: https://travis-ci.org/joaogbcravo/gocdapi\n\nAbout this library\n-------------------\n\nGo is a continuous delivery system - http://www.go.cd/\n\nThe goal of this python library is to be an easy interface for the Go server.\n\nThis project was inspirated in the jenkinsapi library - https://github.com/salimfadhley/jenkinsapi\n\n\nThis library can help you:\n\n* to list Go Agents\n* to enable/disable/delete a Go Agent\n* to see a job run history of an Go Agent\n* to list Go Pipelines Groups and their Pipelines\n* to schedule/release lock/pause/unpause a Go Pipeline\n* to create and delete Go Pipelines from a XML config or delete Go Pipelines\n* to create and delete Go Pipelines Groups\n* to cancel a Go Stage run or see it's history\n\n\nPython versions\n---------------\n\nThe project have been tested and working on 2.7\n\n\nKnown bugs\n----------\n\nCurrently compatible with Go version 14.3.0-1186.\nNo know bugs at the moment.\n\n\nImportant Links\n---------------\n\nGo Continuous Delivery - http://www.go.cd/\n\nProject source code: github: https://github.com/joaogbcravo/gocdapi\n\n\nInstallation\n-------------\n\nUsing Pip\n^^^^^^^^^\n\nRun the command:\n\n.. code-block:: bash\n\n pip install gocdapi\n\n\nInstaling from the source\n^^^^^^^^^^^^^^^^^^^^^^^^^\n\nYou can clone the repository and install:\n\n.. code-block:: bash\n\n git clone https://github.com/joaogbcravo/gocdapi.git\n python setup.py install\n\n\nExample\n-------\ngocdAPI is intended to map the objects in Go (e.g. Pipeline Groups, Pipelines, Agents) into easily managed Python\nobjects:\n\n.. code-block:: python\n\n >>> from gocdapi.go import Go\n >>> go_server = Go(\"http://localhost:8153/\")\n >>>\n >>> for uuid, agent in go_server.agents:\n ... print uuid, \" - \", agent\n ...\n a8b7c2b4-3986-476a-a797-abb3a065587e - Agent @ http://localhost:8153/\n >>>\n >>> agent = go_server.agents[\"a8b7c2b4-3986-476a-a797-abb3a065587e\"]\n >>> agent.enable()\n >>> print agent.status\n Idle\n >>>\n >>> agent.disable()\n >>> print agent.status\n Disabled\n >>>\n >>> for name, pipeline_group in go_server.pipeline_groups:\n ... print name, \" - \", pipeline_group\n ...\n Development - Pipeline @ http://localhost:8153/\n >>>\n >>> pipeline_group = go_server.pipeline_groups[\"Development\"]\n >>> for name, pipeline in pipeline_group:\n ... print name, \" - \", pipeline\n ...\n Web_Services_QA - Pipeline @ http://localhost:8153/\n Deploy_Web_Services - Pipeline @ http://localhost:8153/\n >>>\n\n\nTesting\n-------\n\nAfter the installation of the test dependencies on your system, run the command:\n\n.. code-block:: bash\n\n python setup.py nosetests\n\nNose need a Go Server and Agent to run, so when you execute nosetests it will start a new Go Server and Agent, and it\nwill shutdown them after all the test run. If you haven't the executable in the gocdapi_tests/systests folder it will\ndownload them. This process can be slow, so you can start by yourself a Go Server and Agent and run nosetests in the\nfollowing way:\n\n.. code-block:: bash\n\n python nosetests -s --nologcapture --tc=static_instances:true\n\nTo make a source code analysis, you can run pep8 and pylint:\n\n.. code-block:: bash\n\n pep8 --ignore=E501 gocdapi/*.py\n pylint --rcfile=pylintrc gocdapi/*.py\n\n\nProject Contributors\n--------------------\n\n* Joao Cravo (joaogbcravo@gmail.com)\n\nPlease do not contact these contributors directly for support questions! Use the GitHub tracker instead.\n\n\nLicense\n--------\n\nThe MIT License (MIT)\n=====================\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated\ndocumentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the\nrights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit\npersons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the\nSoftware.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE\nWARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR\nOTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "UNKNOWN", "keywords": null, "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "gocdapi", "package_url": "https://pypi.org/project/gocdapi/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/gocdapi/", "project_urls": { "Download": "UNKNOWN", "Homepage": "UNKNOWN" }, "release_url": "https://pypi.org/project/gocdapi/1.0.3/", "requires_dist": null, "requires_python": null, "summary": "A Python API for accessing resources on a Go continuous-delivery server.", "version": "1.0.3" }, "last_serial": 1626321, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "7ba6d55db50aeca9be5cf251dc1f152d", "sha256": "bf68ac39e3c418a601a761b6d8badc50009b1729a86cc74824a75ea27f886445" }, "downloads": -1, "filename": "gocdapi-1.0.0.tar.gz", "has_sig": false, "md5_digest": "7ba6d55db50aeca9be5cf251dc1f152d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9842, "upload_time": "2015-02-18T00:27:00", "url": "https://files.pythonhosted.org/packages/4c/1f/599a5da763777631e7f0d424106bb501f20e1d894917e755a4a28af83dd5/gocdapi-1.0.0.tar.gz" } ], "1.0.3": [ { "comment_text": "", "digests": { "md5": "cdd9d25d3507c83b5dec0eadd825b4e3", "sha256": "247e845228006ac2c96ebdab8b2d830e2b1708df05bc397b2c1786bcb0de1d5a" }, "downloads": -1, "filename": "gocdapi-1.0.3.tar.gz", "has_sig": false, "md5_digest": "cdd9d25d3507c83b5dec0eadd825b4e3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11181, "upload_time": "2015-07-09T13:35:39", "url": "https://files.pythonhosted.org/packages/78/c5/ec2da1ffca5d27a968c4344a7554aa976e7a5297a15b4d59324f37c2aff9/gocdapi-1.0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "cdd9d25d3507c83b5dec0eadd825b4e3", "sha256": "247e845228006ac2c96ebdab8b2d830e2b1708df05bc397b2c1786bcb0de1d5a" }, "downloads": -1, "filename": "gocdapi-1.0.3.tar.gz", "has_sig": false, "md5_digest": "cdd9d25d3507c83b5dec0eadd825b4e3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11181, "upload_time": "2015-07-09T13:35:39", "url": "https://files.pythonhosted.org/packages/78/c5/ec2da1ffca5d27a968c4344a7554aa976e7a5297a15b4d59324f37c2aff9/gocdapi-1.0.3.tar.gz" } ] }