Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: Output to HTML #849

Open
3 tasks done
ajpenner opened this issue Oct 27, 2024 · 1 comment
Open
3 tasks done

Feature: Output to HTML #849

ajpenner opened this issue Oct 27, 2024 · 1 comment
Labels
component:output-formats Supported output formats enhancement New feature or request

Comments

@ajpenner
Copy link

Pre-submission checks

  • 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.
  • I agree to follow the PSF Code of Conduct.
  • 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

@ajpenner ajpenner added the enhancement New feature or request label Oct 27, 2024
@woodruffw woodruffw added the component:output-formats Supported output formats label Oct 27, 2024
@woodruffw
Copy link
Member

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 🙂


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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:output-formats Supported output formats enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants