# Jenkins Python SDK (jenkins_pysdk)
[](https://jenkinspythonsdk.readthedocs.io/en/latest/?badge=latest)
## Installation
Use the package manager [pip](https://pip.pypa.io/en/stable/installation/) and
[JenkinsPythonSDK | pypi.org](https://pypi.org/project/jenkins-pysdk/) to install jenkins-pysdk.
```bash
pip install jenkins-pysdk
```
## Quick Usage
```python
from jenkins_pysdk.jenkins import Jenkins
jenkins = Jenkins(host="Jenkins.DNS.com", username="<username>", passw="<passw>")
```
#### OR
```python
from jenkins_pysdk.jenkins import Jenkins
jenkins = Jenkins(
host="http://localhost",
port=8080,
username="<username>",
token="<token>",
proxies={
"http": "http://",
"https": "https://"
},
timeout=60,
verify=False
)
```
#### 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](https://jenkinspythonsdk.readthedocs.io/en/latest/index.html)] 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
Raw data
{
"_id": null,
"home_page": "https://github.com/KnownZero/JenkinsPythonSDK",
"name": "jenkins-pysdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "python, Jenkins, SDK, API, REST",
"author": "KnownZero",
"author_email": "gihjeefs@protonmail.com",
"download_url": "https://files.pythonhosted.org/packages/f0/5c/cb0173282da34b22a1abe5202539cee5384d160d75e85728ad5edfecfd1f/jenkins_pysdk-1.4.3.tar.gz",
"platform": null,
"description": "# Jenkins Python SDK (jenkins_pysdk)\r\n\r\n[](https://jenkinspythonsdk.readthedocs.io/en/latest/?badge=latest) \r\n\r\n\r\n\r\n\r\n\r\n\r\n## Installation\r\n\r\nUse the package manager [pip](https://pip.pypa.io/en/stable/installation/) and \r\n[JenkinsPythonSDK | pypi.org](https://pypi.org/project/jenkins-pysdk/) to install jenkins-pysdk.\r\n\r\n```bash\r\npip install jenkins-pysdk\r\n```\r\n\r\n## Quick Usage\r\n\r\n```python\r\nfrom jenkins_pysdk.jenkins import Jenkins\r\njenkins = Jenkins(host=\"Jenkins.DNS.com\", username=\"<username>\", passw=\"<passw>\")\r\n```\r\n#### OR\r\n\r\n```python\r\nfrom jenkins_pysdk.jenkins import Jenkins\r\njenkins = Jenkins(\r\n host=\"http://localhost\",\r\n port=8080,\r\n username=\"<username>\",\r\n token=\"<token>\",\r\n proxies={\r\n \"http\": \"http://\",\r\n \"https\": \"https://\"\r\n },\r\n timeout=60,\r\n verify=False\r\n)\r\n```\r\n#### Why use token= parameter?\r\n```\r\nUsing an API token removes the need for csrf crumbs in your requests. \r\n\r\nThe SDK handles crumbs for you, but using token= will reduce the number of API calls. \r\n```\r\n\r\n### See [[JenkinsPythonSDK Docs](https://jenkinspythonsdk.readthedocs.io/en/latest/index.html)] for full documentation.\r\n\r\n## Contributing\r\n\r\nFeel free to create pull requests.\r\n\r\nFor major changes, please open an issue first\r\nto discuss what you would like to change.\r\n\r\nPlease make sure to update tests as appropriate.\r\n\r\n> [!NOTE]\r\n> I actively support this SDK, but I don't proactively check Jenkins release notes -\r\n> if the SDK is missing something after an upgrade, please raise it in the discussions section.\r\n\r\n\r\n> [!IMPORTANT]\r\n> Code is tested on LTS versions:\r\n> - \"2.121.3\" # (2018)\r\n> - \"2.138.4\" # (2019)\r\n> - \"2.150.3\" # (2019)\r\n> - \"2.164.3\" # (2019)\r\n> - \"2.176.4\" # (2019)\r\n> - \"2.190.3\" # (2020)\r\n> - \"2.204.6\" # (2020)\r\n> - \"2.222.4\" # (2020)\r\n> - \"2.235.5\" # (2021)\r\n> - \"2.249.3\" # (2021)\r\n> - \"2.263.4\" # (2021)\r\n> - \"2.277.4\" # (2021)\r\n> - \"2.289.3\" # (2021)\r\n> - \"2.303.3\" # (2021)\r\n> - \"2.319.1\" # (2022)\r\n> - \"2.332.3\" # (2022)\r\n> - \"2.346.3\" # (2022)\r\n> - \"2.361.4\" # (2023)\r\n> - \"2.375.3\" # (2023)\r\n> - \"2.387.1\" # (2024)\r\n\r\n\r\n## Author\r\nKnownZero\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "2024 Python SDK for Jenkins",
"version": "1.4.3",
"project_urls": {
"Homepage": "https://github.com/KnownZero/JenkinsPythonSDK"
},
"split_keywords": [
"python",
" jenkins",
" sdk",
" api",
" rest"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d14fa75b657f8ef29c19e553e3633d143b7823f5d0e77bfe3cac6799f3149cd0",
"md5": "c78bf0382326dcdeda4e0445617693ea",
"sha256": "7b7fa8c812196dd514bd6e5355c70b1be8302b7571b03975b0fabc8f1519008b"
},
"downloads": -1,
"filename": "jenkins_pysdk-1.4.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c78bf0382326dcdeda4e0445617693ea",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 46821,
"upload_time": "2024-08-12T13:34:22",
"upload_time_iso_8601": "2024-08-12T13:34:22.713953Z",
"url": "https://files.pythonhosted.org/packages/d1/4f/a75b657f8ef29c19e553e3633d143b7823f5d0e77bfe3cac6799f3149cd0/jenkins_pysdk-1.4.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f05ccb0173282da34b22a1abe5202539cee5384d160d75e85728ad5edfecfd1f",
"md5": "24965e81be5a148f198de850dd3ce0bd",
"sha256": "dfe0beb060ae90fabd61502321c919cf2cc1675ac5b61accc99940996d92afad"
},
"downloads": -1,
"filename": "jenkins_pysdk-1.4.3.tar.gz",
"has_sig": false,
"md5_digest": "24965e81be5a148f198de850dd3ce0bd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 38231,
"upload_time": "2024-08-12T13:34:24",
"upload_time_iso_8601": "2024-08-12T13:34:24.321405Z",
"url": "https://files.pythonhosted.org/packages/f0/5c/cb0173282da34b22a1abe5202539cee5384d160d75e85728ad5edfecfd1f/jenkins_pysdk-1.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-12 13:34:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "KnownZero",
"github_project": "JenkinsPythonSDK",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "httpx",
"specs": []
},
{
"name": "urllib3",
"specs": []
}
],
"lcname": "jenkins-pysdk"
}
JSON
