Skip to main content

Asynchronous python library of Jenkins API endpoints based on aiohttp. Initial version of aiojenkins.

Public API is still unstable.

Also pay attention to brand new library with same API set but with sync and async interfaces. https://github.com/pbelskiy/ujenkins

Status

Build Status Docs status Coverage status Version status Downloads status

Installation

pip3 install -U aiojenkins

Documentation

Read the Docs

Usage

Start new build:

import asyncio
import aiojenkins

jenkins = aiojenkins.Jenkins('http://your_server/jenkins', 'login', 'password')

async def example():
    await jenkins.builds.start('job_name', dict(parameter='test'))

loop = asyncio.get_event_loop()
try:
    loop.run_until_complete(example())
finally:
    loop.run_until_complete(jenkins.close())
    loop.close()

Please look at tests directory for more examples.

Testing

Currently tests aren’t using any mocking. I am testing locally with dockerized LTS Jenkins ver. 2.222.3

Prerequisites: docker, tox

docker run -d --name jenkins --restart always -p 8080:8080 jenkins/jenkins:lts
docker exec jenkins cat /var/jenkins_home/secrets/initialAdminPassword
chromium http://localhost:8080  # create admin:admin
tox

Or Jenkins 1.554

docker run -d --name jenkins-1.554 --restart always -p 8081:8080 jenkins:1.554

Contributing

Feel free to PR

Metadata

Release files for aiojenkins 0.7.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aiojenkins 0.7.4
File Size Uploaded Provenance Actions
aiojenkins-0.7.4.tar.gz 14.1 kB Without provenance Details for aiojenkins-0.7.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for aiojenkins 0.7.4
File Interpreter ABI Platform Actions
aiojenkins-0.7.4-py3-none-any.whl Python 3 none any Details for aiojenkins-0.7.4-py3-none-any.whl

Total release size: 32.7 kB

Release files / aiojenkins-0.7.4.tar.gz

Download URL aiojenkins-0.7.4.tar.gz
Size 14.1 kB
Tags Source
SHA-256 checksum
How to use checksums
61f37535e618088c604b8c642b27151ce09e44e15efd1a1c6061988ef2511bc7
BLAKE2b-256 checksum
How to use checksums
45ea9e2f37cf91d204f35c0c8e4b3312c01a1a540f490b4180af4a920688b2c5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.0 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

Release files / aiojenkins-0.7.4-py3-none-any.whl

Download URL aiojenkins-0.7.4-py3-none-any.whl
Size 18.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0e8937fa15293abda1ee28357f796f283e17e6455ef04933501d9ba52919ffba
BLAKE2b-256 checksum
How to use checksums
c0d1058636ad9281432840be50f58c6d6b23827e6d082bb8aae59bcfc7c39a6a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.7.0 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

Security for aiojenkins 0.7.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page