| Name | jautomate JSON |
| Version |
0.0.23
JSON |
| download |
| home_page | None |
| Summary | Automates MDM tasks using the Jamf APIs |
| upload_time | 2024-05-21 14:54:13 |
| maintainer | None |
| docs_url | None |
| author | Dustin Yoxall |
| requires_python | >=3.10 |
| license | MIT |
| keywords |
python
jamf
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Jautomate
This tool automates MDM tasks on Jamf using the Jamf Pro and Jamf Classic API. For now there are only tasks focused on mobile devices. Computer versions of those tasks are in the works.
## Installation
---
A pip installation will be set up once the build has been tested. For now you can install it from the testing PyPi server with this command:
```bash
python3 -m pip install --index-url https://test.pypi.org/simple --extra-index-url https://pypi.org/simple/ jautomate
```
## Setup
### Env Variables
You have to define the following environment variables in a `.env` file to connect to your Jamf Pro server.
```
JPS_USERNAME=[Username]
JPS_PASSWORD=[Password]
JPS_URL=[Url]
```
## Basic Usage
This tool runs from the command line and has basic help information built into it. To access the help functions use the command:
```bash
jautomate --help
```
## Available Commands
### Assign a device
Add student information to a device record in Jamf Pro
```bash
jautomate assign [DEVICE_TYPE] [ASSET_TAG] [SERIAL_NUMBER] [STUDENT_NAME] [HOMEROOM] [STUDENT_GRADE] [BUILDING]
```
**Required arguments**
| | |
| --- | --- |
DEVICE_TYPE | Type of device being updated. {mobile / computer}
ASSET_TAG | Asset tag should be a 6 digit number
SERIAL_NUMBER | Serial Number of device
STUDENT_NAME | Student full name
HOMEROOM | Homeroom teachers last name
STUDENT_GRADE | Student grade as a number
BUILDING | Building names as used in Jamf Pro
### Unassign a device
Remove student information from device record in Jamf Pro.
```bash
jautomate unassign [DEVICE_TYPE] [ASSET_TAG]
```
**Required arguments**
| | |
| --- | --- |
DEVICE_TYPE | Type of device being updated. {mobile / computer}
ASSET_TAG | Asset tag should be a 6 digit number
### Sync multiple device records
Syncs data from a csv file of device records to Jamf Pro. Devices must all be of same type (mobile/computer.)
```bash
jautomate sync [DEVICE_TYPE] [FILE_PATH]
```
**Required arguments**
| | |
| --- | --- |
DEVICE_TYPE | Type of devices being updated. {mobile / computer}
FILE_PATH | The path to the csv file to be imported
# Development
References for dev/testing
```bash
# Run this line from the same directory as setup.py
python -m build
# To test the build you can install/re-install with this line.
pip install dist/jautomate-0.0.7-py3-none-any.whl --force-reinstall
```
Raw data
{
"_id": null,
"home_page": null,
"name": "jautomate",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "python, jamf",
"author": "Dustin Yoxall",
"author_email": "yoxall.dustin@ccpsstaff.org",
"download_url": "https://files.pythonhosted.org/packages/b5/50/6434f28960080d1889dc0697a97be3a8b4e84d1814a28e54ea00b4c5b395/jautomate-0.0.23.tar.gz",
"platform": null,
"description": "# Jautomate\nThis tool automates MDM tasks on Jamf using the Jamf Pro and Jamf Classic API. For now there are only tasks focused on mobile devices. Computer versions of those tasks are in the works.\n\n## Installation\n---\nA pip installation will be set up once the build has been tested. For now you can install it from the testing PyPi server with this command:\n\n```bash\npython3 -m pip install --index-url https://test.pypi.org/simple --extra-index-url https://pypi.org/simple/ jautomate\n```\n\n## Setup\n\n### Env Variables\nYou have to define the following environment variables in a `.env` file to connect to your Jamf Pro server.\n\n```\nJPS_USERNAME=[Username]\nJPS_PASSWORD=[Password]\nJPS_URL=[Url]\n```\n\n## Basic Usage\n\nThis tool runs from the command line and has basic help information built into it. To access the help functions use the command:\n\n```bash\njautomate --help\n```\n## Available Commands\n\n### Assign a device\n\nAdd student information to a device record in Jamf Pro\n\n```bash\njautomate assign [DEVICE_TYPE] [ASSET_TAG] [SERIAL_NUMBER] [STUDENT_NAME] [HOMEROOM] [STUDENT_GRADE] [BUILDING]\n```\n\n**Required arguments**\n\n| | |\n| --- | --- |\nDEVICE_TYPE | Type of device being updated. {mobile / computer}\nASSET_TAG | Asset tag should be a 6 digit number\nSERIAL_NUMBER | Serial Number of device\nSTUDENT_NAME | Student full name \nHOMEROOM | Homeroom teachers last name\nSTUDENT_GRADE | Student grade as a number\nBUILDING | Building names as used in Jamf Pro\n\n\n### Unassign a device\nRemove student information from device record in Jamf Pro.\n\n```bash\njautomate unassign [DEVICE_TYPE] [ASSET_TAG]\n```\n\n**Required arguments**\n\n| | |\n| --- | --- |\nDEVICE_TYPE | Type of device being updated. {mobile / computer}\nASSET_TAG | Asset tag should be a 6 digit number\n\n### Sync multiple device records\nSyncs data from a csv file of device records to Jamf Pro. Devices must all be of same type (mobile/computer.)\n\n```bash\njautomate sync [DEVICE_TYPE] [FILE_PATH]\n```\n\n**Required arguments**\n\n| | |\n| --- | --- |\nDEVICE_TYPE | Type of devices being updated. {mobile / computer}\nFILE_PATH | The path to the csv file to be imported\n\n\n# Development\nReferences for dev/testing\n```bash\n# Run this line from the same directory as setup.py\npython -m build \n# To test the build you can install/re-install with this line.\npip install dist/jautomate-0.0.7-py3-none-any.whl --force-reinstall \n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Automates MDM tasks using the Jamf APIs",
"version": "0.0.23",
"project_urls": null,
"split_keywords": [
"python",
" jamf"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8e11d70ad8fd1f9cb68e66945db8aa019ded6ba1adf2c3660444ec150561076a",
"md5": "245c374aa0caaa6e9fe540e8736c4c58",
"sha256": "f8c76685357b2ac6ea622cb2272d70ca68afe2cc355f941ab22530790d24b784"
},
"downloads": -1,
"filename": "jautomate-0.0.23-py3-none-any.whl",
"has_sig": false,
"md5_digest": "245c374aa0caaa6e9fe540e8736c4c58",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 15837,
"upload_time": "2024-05-21T14:54:10",
"upload_time_iso_8601": "2024-05-21T14:54:10.605304Z",
"url": "https://files.pythonhosted.org/packages/8e/11/d70ad8fd1f9cb68e66945db8aa019ded6ba1adf2c3660444ec150561076a/jautomate-0.0.23-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b5506434f28960080d1889dc0697a97be3a8b4e84d1814a28e54ea00b4c5b395",
"md5": "053ade8e898a5bf0ece705fc800b972a",
"sha256": "e0daefc18219d544aaa3456b51f40e09b438d6717361f814afeb57b6b8a156f2"
},
"downloads": -1,
"filename": "jautomate-0.0.23.tar.gz",
"has_sig": false,
"md5_digest": "053ade8e898a5bf0ece705fc800b972a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 15136,
"upload_time": "2024-05-21T14:54:13",
"upload_time_iso_8601": "2024-05-21T14:54:13.543000Z",
"url": "https://files.pythonhosted.org/packages/b5/50/6434f28960080d1889dc0697a97be3a8b4e84d1814a28e54ea00b4c5b395/jautomate-0.0.23.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-21 14:54:13",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "jautomate"
}
