-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
28 changed files
with
575 additions
and
198 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,37 +1,59 @@ | ||
# Patcher | ||
|
||
_Patch reporting simplified_ | ||
<p align="left"> | ||
<a href="https://patcher.liquidzoo.io/"> | ||
<img src="docs/_static/patcher-banner-readme.svg" width="540"/> | ||
</a> | ||
</p> | ||
|
||
![](https://img.shields.io/pypi/l/patcherctl) ![](https://img.shields.io/badge/Python-3.10+-3776AB.svg?style=flat&logo=python&logoColor=white) ![](https://img.shields.io/github/v/release/liquidz00/Patcher?color=orange) ![](https://github.com/liquidz00/patcher/actions/workflows/pytest.yml/badge.svg) ![](https://img.shields.io/pypi/v/patcherctl?color=yellow) | ||
|
||
---- | ||
|
||
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. | ||
|
||
### Installation | ||
Install via `pip`: | ||
Read the full project documentation [on our project homepage](https://patcher.liquidzoo.io). | ||
|
||
```shell | ||
pip install patcherctl | ||
## Installation | ||
Install releases from PyPI: | ||
|
||
```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 main script. You can specify the output directory for the reports and choose to generate PDF reports alongside Excel files. | ||
```shell | ||
patcherctl --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 Speciale - @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 | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.