| Name | jamf-pro-sdk JSON |
| Version |
0.6a1
JSON |
| download |
| home_page | |
| Summary | Jamf Pro SDK for Python |
| upload_time | 2024-02-16 15:33:40 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | <4,>=3.9 |
| license | MIT |
| keywords |
jamf
pro
jss
jps
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Jamf Pro SDK for Python
A client library for the Jamf Pro APIs and webhooks.
```python
from jamf_pro_sdk import JamfProClient, BasicAuthProvider
client = JamfProClient(
server="dummy.jamfcloud.com",
credentials=BasicAuthProvider("username", "password")
)
all_computers = client.pro_api.get_computer_inventory_v1()
```
Read the full documentation on [GitHub Pages](https://macadmins.github.io/jamf-pro-sdk-python/).
## Installing
Install releases from PyPI:
```console
% python -m pip install jamf-pro-sdk
```
You may also install directly from GitHub if you are testing in-development features and/or changes:
```console
% pip install git+https://github.com/macadmins/jamf-pro-sdk-python.git@<target-ref-or-branch>
```
The Jamf Pro SDK supports Python 3.9+.
# Bugs, Feedback, and Feature Requests
The Jamf Pro SDK for Python is currently in alpha. Not all APIs are available as methods through the clients, and some functionality may change during the alpha based on community feedback.
If you encounter a bug, or undesired behavior, please open a [Bug report issue](https://github.com/macadmins/jamf-pro-sdk-python/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=%5BBug%5D+Issue+title).
If you want to request or propose a change to behavior in the SDK during the alpha please oen a [Feedback issue](https://github.com/macadmins/jamf-pro-sdk-python/issues/new?assignees=&labels=feedback&projects=&template=feedback.md&title=%5BFeedback%5D+Issue+title). Feedback issues are in-between a bug report and a feature request. You are describing a current implementation (or lack thereof) and the desired change. Feedback issues are used for vetting contributions with project maintainers and the community before work begins.
If there is a feature or API you would like added (or prioritized) to the SDK please open a [Feature request issue](https://github.com/macadmins/jamf-pro-sdk-python/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.md&title=%5BFeature+Request%5D+Issue+title). With feature requests include a detailed description and a code example that shows how you envision the feature being used.
> For all issue templates be sure to fill out every section!
# Contributing
There are many ways to directly contribute to the project. You can enhance the documentation and user guides, or add additional API models and methods. For both there are guidelines for how to proceed.
Visit the [Contributors](https://macadmins.github.io/jamf-pro-sdk-python/contributors/index.html) section of the documentation for more details.
Raw data
{
"_id": null,
"home_page": "",
"name": "jamf-pro-sdk",
"maintainer": "",
"docs_url": null,
"requires_python": "<4,>=3.9",
"maintainer_email": "",
"keywords": "jamf,pro,jss,jps",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/77/5c/1a2fba4198c9591820ab727d47814f4fe21ab827381fe0a1e3a8a75cf8a1/jamf-pro-sdk-0.6a1.tar.gz",
"platform": null,
"description": "# Jamf Pro SDK for Python\n\nA client library for the Jamf Pro APIs and webhooks.\n\n```python\nfrom jamf_pro_sdk import JamfProClient, BasicAuthProvider\n\nclient = JamfProClient(\n server=\"dummy.jamfcloud.com\",\n credentials=BasicAuthProvider(\"username\", \"password\")\n)\n\nall_computers = client.pro_api.get_computer_inventory_v1()\n```\n\nRead the full documentation on [GitHub Pages](https://macadmins.github.io/jamf-pro-sdk-python/).\n\n## Installing\n\nInstall releases from PyPI:\n\n```console\n% python -m pip install jamf-pro-sdk\n```\n\nYou may also install directly from GitHub if you are testing in-development features and/or changes:\n\n```console\n% pip install git+https://github.com/macadmins/jamf-pro-sdk-python.git@<target-ref-or-branch>\n```\n\nThe Jamf Pro SDK supports Python 3.9+.\n\n# Bugs, Feedback, and Feature Requests\n\nThe Jamf Pro SDK for Python is currently in alpha. Not all APIs are available as methods through the clients, and some functionality may change during the alpha based on community feedback.\n\nIf you encounter a bug, or undesired behavior, please open a [Bug report issue](https://github.com/macadmins/jamf-pro-sdk-python/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=%5BBug%5D+Issue+title).\n\nIf you want to request or propose a change to behavior in the SDK during the alpha please oen a [Feedback issue](https://github.com/macadmins/jamf-pro-sdk-python/issues/new?assignees=&labels=feedback&projects=&template=feedback.md&title=%5BFeedback%5D+Issue+title). Feedback issues are in-between a bug report and a feature request. You are describing a current implementation (or lack thereof) and the desired change. Feedback issues are used for vetting contributions with project maintainers and the community before work begins.\n\nIf there is a feature or API you would like added (or prioritized) to the SDK please open a [Feature request issue](https://github.com/macadmins/jamf-pro-sdk-python/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.md&title=%5BFeature+Request%5D+Issue+title). With feature requests include a detailed description and a code example that shows how you envision the feature being used.\n\n> For all issue templates be sure to fill out every section!\n\n# Contributing\n\nThere are many ways to directly contribute to the project. You can enhance the documentation and user guides, or add additional API models and methods. For both there are guidelines for how to proceed.\n\nVisit the [Contributors](https://macadmins.github.io/jamf-pro-sdk-python/contributors/index.html) section of the documentation for more details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Jamf Pro SDK for Python",
"version": "0.6a1",
"project_urls": {
"Changelog": "https://github.com/macadmins/jamf-pro-sdk-python/blob/main/CHANGELOG.md",
"Documentation": "https://macadmins.github.io/jamf-pro-sdk-python",
"Source": "https://github.com/macadmins/jamf-pro-sdk-python"
},
"split_keywords": [
"jamf",
"pro",
"jss",
"jps"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "913f787a3aa165e1fdc0123953cd8fd9ad98ee6429c876e8a618398b7eacf81a",
"md5": "98618976059e3c7f397a767ea1d270b4",
"sha256": "6d99a52d4d420a58c3a4f33e37268c5f3798ce348c4c6ffe16afea840b1f2f91"
},
"downloads": -1,
"filename": "jamf_pro_sdk-0.6a1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "98618976059e3c7f397a767ea1d270b4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.9",
"size": 53268,
"upload_time": "2024-02-16T15:33:38",
"upload_time_iso_8601": "2024-02-16T15:33:38.573768Z",
"url": "https://files.pythonhosted.org/packages/91/3f/787a3aa165e1fdc0123953cd8fd9ad98ee6429c876e8a618398b7eacf81a/jamf_pro_sdk-0.6a1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "775c1a2fba4198c9591820ab727d47814f4fe21ab827381fe0a1e3a8a75cf8a1",
"md5": "3ede333e6ea026bab789b62366faa2df",
"sha256": "52ea89c4a69e6475df2576a4d2a987532ddc80d6263d2ae6bb0a642d9874d7d7"
},
"downloads": -1,
"filename": "jamf-pro-sdk-0.6a1.tar.gz",
"has_sig": false,
"md5_digest": "3ede333e6ea026bab789b62366faa2df",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9",
"size": 43966,
"upload_time": "2024-02-16T15:33:40",
"upload_time_iso_8601": "2024-02-16T15:33:40.267474Z",
"url": "https://files.pythonhosted.org/packages/77/5c/1a2fba4198c9591820ab727d47814f4fe21ab827381fe0a1e3a8a75cf8a1/jamf-pro-sdk-0.6a1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-16 15:33:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "macadmins",
"github_project": "jamf-pro-sdk-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jamf-pro-sdk"
}
