patcherctl 2.4.0

Fetch patch management data from Jamf Pro to generate comprehensive reports in both Excel and PDF formats

     

---

Patcher

Simplified patch reporting

Find us in the #patcher channel in the MacAdmins Slack

What is Patcher?

Patcher is a Command Line Interface (CLI) tool for macOS that leverages the Jamf Pro API to fetch patch management data and generates comprehensive reports in varying formats. It simplifies tracking and reporting on software update compliance across macOS devices managed through Jamf Pro.

Read the full project documentation on our project homepage.

Installation

Using UV (Recommended)

UV is a fast Python package installer and resolver. Install UV first:

# On macOS and Linux
$ curl -LsSf https://astral.sh/uv/install.sh | sh

# Or using pip
$ pip install uv

Then install Patcher:

$ uv pip install patcherctl

Using pip

Alternatively, you can install using pip:

$ python3 -m pip install patcherctl

[!NOTE] Please note that while Patcher is installed as a package, it is meant to be used as a command line tool and not as an imported library.

Sample PDF

Assuming 'AnyOrg' is the name of your organization, an exported PDF could look like this:

PDF Reports can be customized to fit your organizations branding needs. See the customizing reports in the project docs.

Usage

For a list of all available commands and options, visit the usage page of our documentation.

After installation, reports can be generated by running the export command. You can specify the output directory for the reports and choose to generate PDF reports alongside Excel files.

$ patcherctl export --path '/path/to/output/directory'

---

Development Setup

For development, we recommend using UV for faster dependency management:

# Clone the repository
$ git clone https://github.com/liquidz00/Patcher.git
$ cd Patcher

# Install UV if not already installed
$ curl -LsSf https://astral.sh/uv/install.sh | sh

# Create virtual environment and install dev dependencies (includes docs)
$ make install-dev

# Run tests
$ make test

# Run linting and formatting
$ make lint
$ make format

Contributing

Contributions to Patcher are welcome! We have set up templates for submitting issues, feature requests, and feedback. Please be sure to utilize these templates when contributing to the project.