Skip to content

Commit

Permalink
Add Slack channel reference.
Browse files Browse the repository at this point in the history
  • Loading branch information
liquidz00 committed Jan 22, 2025
1 parent 0fb01af commit 29d29a4
Showing 1 changed file with 36 additions and 18 deletions.
54 changes: 36 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,34 +8,52 @@

----

# What is Patcher?
Patcher leverages the Jamf Pro API to fetch patch management data and generate comprehensive reports in both Excel and PDF formats. It simplifies tracking and reporting on software update compliance across macOS devices managed through Jamf Pro.
# Patcher

## Documentation
Project documentation can now be found [on our project homepage](https://patcher.liquidzoo.io). All content from our project wiki has been migrated to the new homepage. We are continuously updating references to the new homepage and regularly improving the documentation.
_Simplified patch reporting_

### Sample PDF
Assuming 'AnyOrg' is the name of your organization, an exported PDF could look like this:
<p align="left"><img src="docs/_static/example_pdf.png" width="750"/></p>
<p align="left">
<img src="https://cdn.worldvectorlogo.com/logos/slack-new-logo.svg" width="16" style="vertical-align: middle; margin-right: 5px;"/>
Find us in the <code>#patcher</code> channel in the <a href="https://www.macadmins.org">MacAdmins Slack</a>
</p>

## 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](https://patcher.liquidzoo.io).

## Installation
Install via `pip`:
Install releases from PyPI:

```shell
pip install patcherctl
```console
$ 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.
> Why `patcherctl?` The pip package is called patcherctl because the name patcher was already taken on PyPI. Despite this, the project itself is referred to as Patcher*
## Sample PDF
Assuming 'AnyOrg' is the name of your organization, an exported PDF could look like this:
<p align="left"><img src="docs/_static/example_pdf.png" width="750"/></p>

PDF Reports can be customized to fit your organizations branding needs. See the [customizing reports](https://patcher.liquidzoo.io/user/customize_reports.html) in the project docs.

## Usage
For a list of all available commands and options, visit the [usage page](https://patcher.liquidzoo.io/user/usage.html) of our documentation.

### Usage
After installation, you can generate reports by running the `export` command. You can specify the output directory for the reports and choose to generate PDF reports alongside Excel files.
```shell
patcherctl export --path '/path/to/output/directory' [--pdf]
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.

```console
$ patcherctl export --path '/path/to/output/directory' [--pdf]
```

For a list of all available command options, visit the [usage page](https://patcher.liquidzoo.io/user/usage.html) of our documentation.
***

## Contributing

[Contributions](https://patcher.liquidzoo.io/contributing/index.html) to Patcher are welcome! We have set up templates for submitting [issues](https://github.com/liquidz00/Patcher/issues/new?template=issue.md), [feature requests](https://github.com/liquidz00/Patcher/issues/new?template=feature_request.md), and [feedback](https://github.com/liquidz00/Patcher/issues/new?template=feedback.md). Please be sure to utilize these templates when contributing to the project.

## Authors & Contributions
Patcher is co-authored by [Andrew Lerman - @liquidz00](https://github.com/liquidz00) and [Chris Ball - @ball42](https://github.com/ball42). [Contributions](https://patcher.liquidzoo.io/contributing/index.html) 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.
<!--
Author: Andrew Lerman
Keywords: patcher patcherctl jamf jamfpro macos patch patchmanagement apple
-->

0 comments on commit 29d29a4

Please sign in to comment.