Skip to main content

Convert pip-audit JSON reports into readable HTML reports

Project description

pip-audit-html

Convert pip-audit JSON output into a standalone, readable HTML report.

Why this package

  • Easy CLI for local use and CI pipelines
  • No runtime dependencies
  • Generates a single HTML file you can archive or share

Installation

From PyPI (after publish):

pip install pip-audit-html

From source during development:

pip install -e .[dev]

CLI usage

Generate a report from file:

pip-audit-html pip-audit-report.json -o reports/security-report.html

Pipe input from stdin:

pip-audit --format json | pip-audit-html - -o reports/security-report.html

Set custom title and fail build if vulnerabilities exist:

pip-audit-html pip-audit-report.json -o report.html --title "Weekly Dependency Security" --fail-on-vulns

Default footer attribution is included in generated reports. You can override it if needed:

pip-audit-html pip-audit-report.json -o report.html --author-name "Your Name" --author-url "https://www.linkedin.com/in/your-profile/"

Hide specific vulnerabilities (IDs/CVEs) from rendered HTML output:

pip-audit-html pip-audit-report.json -o report.html --ignore-vuln PYSEC-2024-10 --ignore-vuln CVE-2024-12345

You can also pass comma-separated values:

pip-audit-html pip-audit-report.json -o report.html --ignore-vuln "PYSEC-2024-10,CVE-2024-12345"

You can also run it as a module:

python -m pip_audit_html pip-audit-report.json -o report.html

Local development

Use existing helper scripts:

  1. Create environment (001_env.bat or 001_env.sh)
  2. Activate environment (002_activate.bat or 002_activate.sh)
  3. Install package/dev deps (003_setup.bat or 003_setup.sh)
  4. Run CLI help (004_run.bat or 004_run.sh)
  5. Run tests (005_run_test.bat or 005_run_test.sh)

Publish to PyPI

  1. Update version in pyproject.toml.
  2. Build distributions:
python -m pip install --upgrade build twine
python -m build
  1. Validate artifacts:
python -m twine check dist/*
  1. Upload:
python -m twine upload dist/*

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pip_audit_html-0.1.4.tar.gz (11.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pip_audit_html-0.1.4-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file pip_audit_html-0.1.4.tar.gz.

File metadata

  • Download URL: pip_audit_html-0.1.4.tar.gz
  • Upload date:
  • Size: 11.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pip_audit_html-0.1.4.tar.gz
Algorithm Hash digest
SHA256 f19f1384749ce56cb8ce5d06111071e240e21eb80c4c1f1e2ef2114806f7a5cd
MD5 cbe46707922aca36409b7bde0fb351a9
BLAKE2b-256 477ddbccd29a35809585ddd13bfe5605dd9c253b3515a45f12568a9ef265f04d

See more details on using hashes here.

Provenance

The following attestation bundles were made for pip_audit_html-0.1.4.tar.gz:

Publisher: workflow.yml on ShanKonduruCoforge/pip-audit-html

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pip_audit_html-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: pip_audit_html-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 10.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pip_audit_html-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b72493f1599bfec7fe47db0de1e4345778727220ef5cb60153b45b0ad47681af
MD5 da39a2d85fb90c8bc14e7969d4a1726f
BLAKE2b-256 455cc122ae4f94c7f8ced160f9f31d9e00758593cb25d47d6bfeefb910e87903

See more details on using hashes here.

Provenance

The following attestation bundles were made for pip_audit_html-0.1.4-py3-none-any.whl:

Publisher: workflow.yml on ShanKonduruCoforge/pip-audit-html

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page