Skip to main content

Provedown

Provedown makes claims in Markdown and HTML reports independently verifiable. Attach small Python or DuckDB SQL calculations to important values, then run a deterministic verifier to catch stale or incorrect prose.

Documentation | First verified report | Markup reference

Install

Provedown requires Python 3.10 or later and is available from PyPI:

pip install provedown

Quick Start

Create report.md:

# Order Summary

<pre><code>
orders = [
    {"status": "paid", "amount": 120},
    {"status": "refunded", "amount": 45},
    {"status": "paid", "amount": 75},
]
paid = [order for order in orders if order["status"] == "paid"]
total = sum(order["amount"] for order in paid)
</code></pre>

The report includes <span class="result" data-code="len(paid)">2<span class="method"></span></span> paid orders totaling <span class="result" data-code="f'${total}'">$195<span class="method"></span></span>.

Verify it:

provedown verify report.md

Provedown reruns the calculation and checks both authored values:

report.md: ok
  pass=2, fail=0, skip=0, error=0

The HTML elements have separate jobs:

  • code contains executable evidence. The surrounding pre preserves its multiline layout for readers.
  • span.result contains an authored value and the expression that must reproduce it.

Provedown reports mismatches but does not rewrite the document. The Markdown or HTML file remains the source of truth.

Capabilities

  • Execute embedded Python or DuckDB SQL.
  • Query local CSV files from SQL or Python reports.
  • Check exact values, numeric tolerances, and set equality.
  • Reuse named calculations across multiple claims.
  • Inspect dependencies between evidence and claims.
  • Render evidence as visible, expandable, or claim-only HTML.

Learn More

Download files

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

Source Distribution

provedown-0.1.0.tar.gz (124.0 kB view details)

Uploaded Source

Built Distribution

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

provedown-0.1.0-py3-none-any.whl (31.0 kB view details)

Uploaded Python 3

File details

Details for the file provedown-0.1.0.tar.gz.

File metadata

  • Download URL: provedown-0.1.0.tar.gz
  • Upload date:
  • Size: 124.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for provedown-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ae1bf6c99fc5eed136b5b2ba2dd9dc6026ff405fbc8b6145c4eac67c7a65037b
MD5 e9a1af1510592f5590e1fde5ed2889e3
BLAKE2b-256 8c1ff9fda784045bb25fd95ceee1f8c59f267ebcf816df86b70f2812a02c2e6a

See more details on using hashes here.

Provenance

The following attestation bundles were made for provedown-0.1.0.tar.gz:

Publisher: pypi-publish.yaml on ai4curation/provedown

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

File details

Details for the file provedown-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: provedown-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 31.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for provedown-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a9b491061a2592b7d82d66d78530ef0c9b0f4565937cc96f599865ebf0c304db
MD5 ceb83636a2411d388a3e1a83472d2536
BLAKE2b-256 07a41f67bc3540bc1431ecfc1068636c5126d94e0b27edc37c0312641ad8ae9e

See more details on using hashes here.

Provenance

The following attestation bundles were made for provedown-0.1.0-py3-none-any.whl:

Publisher: pypi-publish.yaml on ai4curation/provedown

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 Sentry Error logging StatusPage Status page