pyjamfpro 0.1.1

Asynchronous client for Jamf Classic/Pro API

PyJamfPro is a basic Python wrapper for asynchronous communication with the Jamf Pro (and/or Classic) API. The goal is to simplify the process of communicating with the Jamf Pro device management server API by handling authentication and decoding, allowing you to focus on using the data, not retrieving it.

PyJamfPro is not endorsed, sponsored, or affilitated with Jamf in any way.

---

Usage

Begin by installing the PyJamfPro module, using pip.

pip install pyjamfpro

In your code, simply import the PyJamfPro module and instantiate a new client object. The constructor requires three arguments:

1. base_url - the base URL of your Jamf Pro server
2. username
3. password

• Note: The Jamf Pro API uses the standard User Accounts and Groups functionality of Jamf Pro. You will need to ensure the account you use has the proper privilages for the actions you would like to perform with the API.

from pyjamfpro import jamfpro

client = jamfpro.Client('https://example.jamfserver.com', 'username', 'password')

Once you have a client, you can start making asynchronous calls to the API.

# returns list of all mobile devices, using the Classic API
devices = await client.classic_mobile_devices()

# returns a dictionary of inventory data for the mobile device with ID 1234,
# using the Classic API
device = await client.classic_mobile_device_for_id(1234)

# returns a list of all computers, using the Jamf Pro API
computers = await client.pro_computers()

Refer to the endpoints.py file for other built-in methods. Additionally, you can use the fetch_data and fetch_paginated_data methods to access any Jamf API endpoint. Basic support for POST has been included through the post_data method.

Contributing

If you have a feature or idea you would like to see added to PyJamPro, please create an issue explaining your idea.

Likewise, if you come across a bug, please create an issue explaining the bug with as much detail as possible.

The Jamf Pro API provides access to a lot of information and, unfortunately, we don't have time to research and implement every endpoint. Please feel free to open a pull request with any additional endpoints you create. We would love to have as many of the core endpoints covered as possible.

License

PyJamPro is released under an MIT license. See LICENSE for more information.