ujenkins 0.7.2

Universal (sync/async) Python client for Jenkins

---

Python client for Jenkins which supports both sync and async syntax with same interface.

Comparison to other packages
Name	Sync	Async	Python
ujenkins	YES	YES	3.6+
aiojenkins	NO	YES	3.5+
python-jenkins	YES	NO	3.4+
jenkinsapi	YES	NO	3.4+

Installation

Latest release from PyPI

pip3 install ujenkins

Or latest developing version

pip3 install git+https://github.com/pbelskiy/ujenkins

Usage

Get Jenkins version using sync client:

from ujenkins import JenkinsClient

def example():
    client = JenkinsClient('http://server', 'user', 'password')
    version = client.system.get_version()
    print(version)

example()

With async client (be careful AsyncJenkinsClient must be called inside async function):

import asyncio
from ujenkins import AsyncJenkinsClient

async def example():
    client = AsyncJenkinsClient('http://server', 'user', 'password')
    version = await client.system.get_version()
    print(version)

asyncio.run(example())

Examples

In all code examples below client instance is created by:

from ujenkins import JenkinsClient
client = JenkinsClient('http://server', 'user', 'password')

Get timestamp of latest build:

client.builds.get_info('job', 'lastBuild')['timestamp']

Get url of started build:

item_id = client.builds.start('my_job')
while True:
    time.sleep(5)
    info = client.queue.get_info(item_id)
    if 'executable' in info:
        print(info['executable']['url'])
        break

Please look at tests directory for more examples.

Documentation

Read the Docs

Testing

Prerequisites: tox

Then just run tox, all dependencies and checks will run automatically

tox

Contributing

Any contributions are welcome!