vcti-measure-report
Reports from a vcti-measure artifact through Jinja2 templates — one projection, any output format.
An artifact records one run completely. It is not a report. Turning it into one means resolving axis labels, grouping by item, pairing each reading with the target that applies to it, and accounting for the points that produced nothing — and none of that changes when the output format does.
So this package does that work once, in Python, and leaves templates to do only syntax. It projects an artifact into flat rows carrying everything a report needs, and renders those rows through a template. Which is why one package serves HTML, Markdown and CSV, and why a user can add a format by writing a template rather than by waiting for a package.
Installation
pip install vcti-measure-report
In requirements.txt
vcti-measure-report>=2.0.0,<3
In pyproject.toml dependencies
dependencies = [
"vcti-measure-report>=2.0.0,<3",
]
Quick Start
Read an artifact and render it:
from vcti.measure.report import Report
report = Report.from_text(path.read_text(encoding="utf-8"), title="Week 36")
print(report.render("summary.md"))
print(report.render("long.csv"))
A Report validates the document through vcti-measure once, when it is
built, then renders as many formats as you like from that one pass. It never
writes anything — rendering returns text, so storage policy stays with you.
Add your own format by writing a template:
print(report.render("our-house-style.html", template_dirs=["./templates"]))
Your template is an addition, not a replacement: the bundled names resolve
first, so summary.md and long.csv are reserved. Name yours something
else — including when it started life as a copy of one of ours.
A template receives flat rows — one per observation per metric, with the
axis label, the unit, the target and the status already resolved — so
grouping is Jinja's own groupby and selectattr, not an accumulator:
{% for item, irows in rows | selectattr("role", "equalto", "subject") | groupby("item") %}
### {{ item }}
{% for r in irows %}
| {{ r.coordinate_label }} | {{ r.metric }} | {{ r.value | quantity(r.unit) }} |
{% endfor %}
{% endfor %}
What this package does not do
- Produce artifacts — it reads them. Declaring measurements and running
instruments belong to
vcti-measureand to domain packages above it. - Define validity — a
Reportdoes validate, by callingvcti-measure'svalidate_artifact: it refuses to render what core would refuse to read. The rules themselves live in one place, and it is not here. - Write files — rendering returns text.
- Compare across runs — a row is joinable across artifacts by construction, but accumulating them is somebody else's job.
Each of these is explained in docs/design.md.
Dependencies
vcti-measure for the artifact and its validation, vcti-template for
template loading and strict rendering, vcti-escapers for the per-medium
escapers a template applies, and pydantic for the row model. Charting is
deferred, and no charting dependency is taken.
Documentation
| If you want to… | Read |
|---|---|
| Solve a real reporting problem | docs/patterns.md |
| Understand the architecture and design decisions | docs/design.md |
| Navigate and change the code | docs/source-guide.md |
| Add a format, a filter or a field | docs/extending.md |
Metadata
Release files for vcti-measure-report 2.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| vcti_measure_report-2.0.0.tar.gz | 43.0 kB | With provenance | Details for vcti_measure_report-2.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| vcti_measure_report-2.0.0-py3-none-any.whl | Python 3 | none | any | Details for vcti_measure_report-2.0.0-py3-none-any.whl |
Total release size: 66.1 kB
Release files / vcti_measure_report-2.0.0.tar.gz
| Download URL | vcti_measure_report-2.0.0.tar.gz |
|---|---|
| Size | 43.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5ad08a8f6667cccb41437555f0a55d2a2df0b01b5a2d2c676ec5ff159ec7e769
|
|
BLAKE2b-256 checksum How to use checksums |
f3aa088f253e1ac716b38055bd09cfc3485e41e378b5e56aaf8111deca8546d7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 5, 2026.
Transparency logRelease files / vcti_measure_report-2.0.0-py3-none-any.whl
| Download URL | vcti_measure_report-2.0.0-py3-none-any.whl |
|---|---|
| Size | 23.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d18686679b0d20591506187ab4a3d25886e2c887fd68a8f46e8bc81d176263c9
|
|
BLAKE2b-256 checksum How to use checksums |
6bd8e6b7e673bed713a2684bd7ae3e03283735c67de1e0cd57a0915c93619378
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 5, 2026.
Transparency logSecurity for vcti-measure-report 2.0.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.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for vcti_measure_report-2.0.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 5, 2026.
Transparency logA 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.