A Python API for interacting with Go Continuous Delivery
Project description
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.
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.
Versioning
Semantic versioning is used.
License
MIT License.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
File details
Details for the file gocd-0.14.0.tar.gz.
File metadata
- Download URL: gocd-0.14.0.tar.gz
- Upload date:
- Size: 14.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5faebe5db280b16225a97a838859c1e53272c053e588ba4df52ba7cd3c860630 |
|
| MD5 | 57095656defe54ab2f15769333607c0c |
|
| BLAKE2b-256 | 44f0d5c1c98cfd2539daba896ae931a84583374c5f9d613fa3dc534053864f7c |
File details
Details for the file gocd-0.14.0-py3-none-any.whl.
File metadata
- Download URL: gocd-0.14.0-py3-none-any.whl
- Upload date:
- Size: 20.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3ecd7ae42e5baedab41b8c12d6ee6f5302a62a89f982ff54869a88705f19a26b |
|
| MD5 | 5de36f858559e6c90af996da135bb568 |
|
| BLAKE2b-256 | d0ffed2784dc7b3043c2af84008d2f4f17292da12c5ebf1245d02c1e7e2494f1 |
File details
Details for the file gocd-0.14.0-py2-none-any.whl.
File metadata
- Download URL: gocd-0.14.0-py2-none-any.whl
- Upload date:
- Size: 20.7 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5ac6972992a5ca94241094fe2896252abdd47328258664671570a494589264b0 |
|
| MD5 | 862cb8b651d96c272001509c95cd3c65 |
|
| BLAKE2b-256 | cd42955c3f4b61616b366448bf60849a9976e04c82dd8b9654b4c01c84887f97 |
