Skip to content

gaqzi/py-gocd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

9d06ff1 · Aug 23, 2015

History

59 Commits
Aug 9, 2015
Aug 23, 2015
Aug 23, 2015
Aug 9, 2015
Jul 15, 2015
Aug 9, 2015
Jul 14, 2015
Aug 23, 2015
Jul 12, 2015
Aug 18, 2015
Aug 18, 2015
Aug 11, 2015
Aug 23, 2015
Aug 9, 2015
Aug 9, 2015
Aug 9, 2015

Repository files navigation

A Python API for interacting with Go Continuous Delivery

Coverage Status Build Status Documentation Status Latest Version Downloads Python versions Package status

The reason for this project is to provide a wrapper to easily perform operations against Go. I've been writing a lot of shell scripts to interact with Go using curl, but when going a little further than the most basic interactions I've always started to feel the need for doing all of this in a proper programming language. I.e. something that is beyond bash.

I've chosen to use Python and version 2.6.6 and newer as my target platform, with no external dependencies, to make it really straightforward to install/run on RHEL6 and other similar stable distributions. Python 3 is currently not supported but I want to support it.

This library was created to support a Go CLI, to handle some common scenarios you as an admin or advanced user would do.

API documentation available on read the docs.

Usage

The main interaction point for this library is the Server class, it contains helpers to instantiate the different API endpoints.

An example interaction:

>>> from gocd import Server
>>> server = Server('http://localhost:8153', user='ba', password='secret')
>>> pipeline = server.pipeline('Example-Pipeline')
>>> response = pipeline.history()
>>> bool(response)
True
>>> response.status_code
200
>>> response.content_type
'application/json'
>>> response.is_ok
True
>>> response.body
{"pagination":{"offset":0,"total":1,"page_size":10},"pipelines":[...]"}

Style

This project aims to follow the Google Python Style Guide and particularly the section on commenting the code.

License

MIT License.