Skip to main content

klyrek-report

Turns a klyrek_core.models.ScanResult — everything the rest of the ecosystem accumulated — into an actual report, in three formats:

  • render_markdown — a Markdown report (executive summary, findings grouped by severity, technology/endpoint tables). Renders cleanly on GitHub/GitLab or in any editor.
  • render_json — the full ScanResult as JSON, for klyrek-dashboard or other tooling to consume.
  • render_html — a self-contained, styled HTML report. All target-derived content (finding titles, evidence, endpoint URLs) is HTML-escaped before embedding, since that content ultimately came from the site being scanned and should never be trusted to render as raw HTML in a report someone opens in a browser.

remediation.remediation_for(title) maps the finding titles Klyrek's own detectors (klyrek-headers, klyrek-js, klyrek-assets, ...) produce to generic remediation guidance — a fixed, curated lookup, not an open-ended knowledge base.

from klyrek_report.markdown import render_markdown
from klyrek_report.html import render_html
from klyrek_report.json_export import render_json

report_md = render_markdown(scan_result)
report_html = render_html(scan_result)
report_json = render_json(scan_result)

Metadata

Release files for klyrek-report 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for klyrek-report 0.1.0
File Size Uploaded Provenance Actions
klyrek_report-0.1.0.tar.gz 7.3 kB Without provenance Details for klyrek_report-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for klyrek-report 0.1.0
File Interpreter ABI Platform Actions
klyrek_report-0.1.0-py3-none-any.whl Python 3 none any Details for klyrek_report-0.1.0-py3-none-any.whl

Total release size: 15.4 kB

Release files / klyrek_report-0.1.0.tar.gz

Download URL klyrek_report-0.1.0.tar.gz
Size 7.3 kB
Tags Source
SHA-256 checksum
How to use checksums
482d6a9bb01152bb65d56e1b33b9505e6df314135e374d04da2cbf4807428e37
BLAKE2b-256 checksum
How to use checksums
b96cbe49cd95c64c927767a810597e5c504b416eb64e1388013458e4567afe87
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.2

Release files / klyrek_report-0.1.0-py3-none-any.whl

Download URL klyrek_report-0.1.0-py3-none-any.whl
Size 8.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e1b2af8731e29e02e2114c540ec6cffb266e1ba93ed48f80a6a6cb2eec803284
BLAKE2b-256 checksum
How to use checksums
7fa23d9131fc9ec24c603742bdbffcf19f828dca49a50640df012755b08a5e00
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.2

Security for klyrek-report 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page