jenkins-pysdk

Jenkins Python SDK (jenkins_pysdk)

Installation

Use the package manager pip and JenkinsPythonSDK | pypi.org to install jenkins-pysdk.

pip install jenkins-pysdk

Quick Usage

from jenkins_pysdk.jenkins import Jenkins
jenkins = Jenkins(host="Jenkins.DNS.com", username="<username>", passw="<passw>")

OR

from jenkins_pysdk.jenkins import Jenkins
jenkins = Jenkins(
    host="http://localhost",
    port=8080,
    username="<username>",
    token="<token>",
    proxies={
        "http://": "http://localhost:8080",
        "https://": "http://<username>:<password>@localhost:8080"
    },
    timeout=60,
    verify=False
)

Proxies

For more advanced proxy usage, see HTTPX docs:
https://www.python-httpx.org/advanced/transports/#routing

Why use token= parameter?

Using an API token removes the need for csrf crumbs in your requests. 

The SDK handles crumbs for you, but using token= will reduce the number of API calls. 

See [JenkinsPythonSDK Docs] for full documentation.

Contributing

Feel free to create pull requests.

For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

[!NOTE] I actively support this SDK, but I don't proactively check Jenkins release notes - if the SDK is missing something after an upgrade, please raise it in the discussions section.

[!IMPORTANT] Code is tested on LTS versions:

• "2.121.3" # (2018)
• "2.138.4" # (2019)
• "2.150.3" # (2019)
• "2.164.3" # (2019)
• "2.176.4" # (2019)
• "2.190.3" # (2020)
• "2.204.6" # (2020)
• "2.222.4" # (2020)
• "2.235.5" # (2021)
• "2.249.3" # (2021)
• "2.263.4" # (2021)
• "2.277.4" # (2021)
• "2.289.3" # (2021)
• "2.303.3" # (2021)
• "2.319.1" # (2022)
• "2.332.3" # (2022)
• "2.346.3" # (2022)
• "2.361.4" # (2023)
• "2.375.3" # (2023)
• "2.387.1" # (2024)

Author

KnownZero