Metadata-Version: 2.3
Name: dmarc-report
Version: 0.1.0
Summary: Displays a nicely formatted report in your terminal from a DMARC XML report.
Author-email: Stuart Maxwell <stuart@amanzi.nz>
Requires-Python: >=3.9
Requires-Dist: defusedxml>=0.7.1
Requires-Dist: rich>=13.9.4
Provides-Extra: test
Requires-Dist: nox>=2024.10.9; extra == 'test'
Requires-Dist: pytest>=8.3.4; extra == 'test'
Description-Content-Type: text/markdown

# DMARC Report Tool

Displays a nicely formatted report in your terminal from a DMARC XML report.

## Installation

This works best when installed with `uvx` or `pipx`.

```bash
# With uvx:
uvx install dmarc-report

# Or with pipx:

pipx install dmarc-report
```

## Usage

Run the `dmarc-report` command-line utility followed by a DMARC report file.
The DMARC report can have one of the following file extensions:

- `.xml.gz`
- `.zip`
- `.xml`

```bash
dmarc-report long-dmarc-report-filename.xml.gz
# or
dmarc-report long-dmarc-report-filename.xml
# or
dmarc-report long-dmarc-report-filename.zip
```

Note: if using a zip file, it will only parse the first xml file found in the zip file.
