Feature: Output to HTML

pypa / pip-audit

Audits Python environments, requirements files and dependency trees for known security vulnerabilities, and can automatically fix them

Apache License 2.0

982 stars 62 forks source link

Pre-submission checks

[X] I am not reporting a new vulnerability or requesting a new vulnerability identifier. These must be reported or managed via upstream dependency sources or services, not this repository.
[X] I agree to follow the PSF Code of Conduct.
[X] I have looked through the open issues for a duplicate request.

What's the problem this feature will solve?

I am using this tool in a CI that does not handle the existing report styles, but it will handle html (currently I am looking at using markdown2 to convert the markdown your tool does produce.) It would be more convenient if this tool would output in the html format directly

Describe the solution you'd like

The solution I would like is to have an html formatted report. I suspect this would be straight forward since the hard work is already done to make the markdown pretty.

Additional context

No response

Thanks for the feature request @ajpenner!

I'm a -0 on this: I don't think it would be hard to add (since we could wrap the existing Markdown output, like you said), but HTML has more degrees of freedom around styling (and headers/footers) that users will probably want to specialize, leaving us with an open-ended set of feature requests.

I'll let the other maintainers chime in, though -- if we explicitly constrained it to "emits unstyled HTML" then this is a pretty trivial feature change :slightly_smiling_face:

In the mean time, you could probably use pandoc or grip to to this conversion as part of a pipeline:

pip-audit --format=markdown | pandoc -f markdown -t html -o report.html

pypa / pip-audit