dmarc-report 0.1.0__tar.gz

dmarc_report-0.1.0/.gitignore

@@ -0,0 +1,98 @@
+# Django #
+*.log
+*.pot
+*.pyc
+__pycache__
+*.sqlite3
+media
+staticfiles
+
+# Backup files #
+*.bak
+
+# Python #
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+.pytest_cache/
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery
+celerybeat-schedule.*
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# sftp configuration file
+sftp-config.json
+
+# Package control specific files Package
+Control.last-run
+Control.ca-list
+Control.ca-bundle
+Control.system-ca-bundle
+GitHub.sublime-settings
+
+# Visual Studio Code #
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+.history
+
+# Macos
+.DS_Store

dmarc_report-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+default_language_version:
+  python: python3.13
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-ast
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.8.2
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

dmarc_report-0.1.0/.vscode/launch.json

@@ -0,0 +1,15 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python Debugger: Current File",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${file}",
+            "console": "integratedTerminal"
+        }
+    ]
+}

dmarc_report-0.1.0/.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+    "python.testing.pytestArgs": [
+        ".",
+        "-v"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

dmarc_report-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Stuart Maxwell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

dmarc_report-0.1.0/PKG-INFO

@@ -0,0 +1,48 @@
+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.

dmarc_report-0.1.0/README.md

@@ -0,0 +1,35 @@
+# 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.

dmarc_report-0.1.0/justfile

@@ -0,0 +1,72 @@
+# Set the default recipe to list all available commands
+@default:
+    @just --list
+
+#Set the uv command to run a tool
+uv-tool := "uv tool run"
+
+# Run Ruff linting
+@lint:
+    {{uv-tool}} ruff check
+
+# Run tests wth pytest
+@test:
+    uv run pytest
+
+# Run nox
+@nox:
+    {{uv-tool}} nox --session test
+
+# Run Ruff formatting
+@format:
+    {{uv-tool}} ruff format
+
+# Sync the package
+@sync:
+    uv sync --all-extras
+
+# Sync the package
+@sync-up:
+    uv sync --all-extras --upgrade
+
+# Lock the package version
+@lock:
+    uv lock
+
+# Build the package
+@build:
+    uv build
+
+# Publish the package - this requires a $HOME/.pypirc file with your credentials
+@publish:
+      rm -rf ./dist/*
+      uv build
+      {{uv-tool}} twine check dist/*
+      {{uv-tool}} twine upload dist/*
+
+# Install pre-commit hooks
+@pc-install:
+    {{uv-tool}} pre-commit install
+
+# Upgrade pre-commit hooks
+@pc-up:
+    {{uv-tool}} pre-commit autoupdate
+
+# Run pre-commit hooks
+@pc-run:
+    {{uv-tool}} pre-commit run --all-files
+
+# Use BumpVer to increase the patch version number. Use just bump -d to view a dry-run.
+@bump *ARGS:
+    uv run bumpver update --patch {{ ARGS }}
+    uv sync
+
+# Use BumpVer to increase the minor version number. Use just bump -d to view a dry-run.
+@bump-minor *ARGS:
+    uv run bumpver update --minor {{ ARGS }}
+    uv sync
+
+# Use BumpVer to increase the major version number. Use just bump -d to view a dry-run.
+@bump-major *ARGS:
+    uv run bumpver update --major {{ ARGS }}
+    uv sync

dmarc_report-0.1.0/noxfile.py

@@ -0,0 +1,10 @@
+"""Nox file."""
+
+import nox
+
+
+@nox.session(venv_backend="uv", python=["3.9", "3.10", "3.11", "3.12", "3.13"])
+def test(session: nox.Session) -> None:
+    """Run the test suite."""
+    session.install("-e", ".", "--extra", "test", "-r", "pyproject.toml")
+    session.run("pytest")

dmarc_report-0.1.0/pyproject.toml

@@ -0,0 +1,40 @@
+[project]
+name = "dmarc-report"
+version = "0.1.0"
+description = "Displays a nicely formatted report in your terminal from a DMARC XML report."
+readme = "README.md"
+authors = [{ name = "Stuart Maxwell", email = "stuart@amanzi.nz" }]
+requires-python = ">=3.9"
+dependencies = ["defusedxml>=0.7.1", "rich>=13.9.4"]
+
+[project.scripts]
+dmarc-report = "dmarc_report.report:report"
+
+[dependency-groups]
+dev = ["bumpver>=2024.1130"]
+
+[project.optional-dependencies]
+test = ["nox>=2024.10.9", "pytest>=8.3.4"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.ruff]
+line-length = 120
+target-version = "py313"
+select = ["ALL"]
+ignore = [
+    "D203",  # https://docs.astral.sh/ruff/rules/one-blank-line-before-class/
+    "D213",  # https://docs.astral.sh/ruff/rules/multi-line-summary-second-line/
+    "UP007",
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google" # Accepts: "google", "numpy", or "pep257".
+
+[tool.ruff.per-file-ignores]
+"test*" = ["ALL"]
+
+[tool.pytest.ini_options]
+python_files = "test_*.py"

dmarc_report-0.1.0/src/dmarc_report/__init__.py

@@ -0,0 +1 @@
+"""DMARC report parser and display tool."""