Skip to main content

Traceability Tooling

Universal traceability validation and rollup for requirements ↔ tests mapping. Designed to work across monorepos and git submodules.

Install

pip install tracetree

Quick Start

From a repo root with docs/traceability/:

tracetree init
tracetree validate
tracetree link
tracetree aggregate

Expected Structure (Defaults)

  • docs/traceability/requirements.md
  • docs/traceability/risk_controls.md
  • docs/traceability/traceability_matrix.csv
  • docs/traceability/soup_inventory.md
  • docs/traceability/iec62304_mapping.csv
  • docs/traceability/verification_plan.md

If you do not already have these files, run:

tracetree init

Generated reports (default):

  • docs/traceability/generated/traceability_report.md
  • docs/traceability/generated/traceability_report.json
  • docs/traceability/generated/testid_links.md
  • docs/traceability/generated/testid_links.json
  • docs/traceability/generated/aggregate/traceability_rollup.md
  • docs/traceability/generated/aggregate/traceability_rollup.json
  • docs/traceability/generated/iec62304_traceability_table.md

Test discovery defaults:

  • GTest: tests/, test/
  • Pytest: tests/, test/
  • JS/TS (Jest/Mocha/Vitest): tests/, test/, __tests__/, spec/
  • Rust (#[test]): tests/, test/, src/

TestID matching:

  • GTest: SuiteName.TestName
  • Pytest: test_function_name
  • JS/TS: string in test("name", ...) or it("name", ...)
  • Rust: function name following #[test]

IEC 62304 mapping file format (iec62304_mapping.csv):

RequirementID,SoftwareItem,IntegrationSystemTest,Evidence
REQ-EXAMPLE-1,Example Module,verify_reliability.py,Test logs

Repo Configuration

Create .traceability/config.json to override defaults:

{
  "traceability_dir": "docs/traceability",
  "traceability_output_dir": "docs/traceability/generated",
  "requirements_file": "requirements.md",
  "risk_controls_file": "risk_controls.md",
  "matrix_file": "traceability_matrix.csv",
  "iec62304_mapping_file": "iec62304_mapping.csv",
  "gtest_roots": ["tests"],
  "pytest_roots": ["bindings/python/tests"],
  "js_roots": ["packages/web/tests"],
  "rust_roots": ["crates/core/tests", "crates/core/src"]
}

You can also point to a custom config with TRACEABILITY_CONFIG=/path/to/config.json.

Coverage Threshold

Default is 100%. Override with:

TRACEABILITY_REQ_COVERAGE=0.95 tracetree validate

Submodule Rollup

tracetree aggregate reads .gitmodules and validates each submodule that contains traceability files. Results are written to: docs/traceability/generated/aggregate/traceability_rollup.md. Combined source + generated files are copied to: docs/traceability/generated/aggregate/combined/.

Metadata

Release files for tracetree 0.1.7

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

Source distribution (sdist)

Source distribution for tracetree 0.1.7
File Size Uploaded Provenance Actions
tracetree-0.1.7.tar.gz 10.8 kB Without provenance Details for tracetree-0.1.7.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for tracetree 0.1.7
File Interpreter ABI Platform Actions
tracetree-0.1.7-py3-none-any.whl Python 3 none any Details for tracetree-0.1.7-py3-none-any.whl

Total release size: 21.4 kB

Release files / tracetree-0.1.7.tar.gz

Download URL tracetree-0.1.7.tar.gz
Size 10.8 kB
Tags Source
SHA-256 checksum
How to use checksums
30b6efdd23a6ba9acb084855482f4b3eb4d4ec8a63a32b02ee5e97a5dc343936
BLAKE2b-256 checksum
How to use checksums
e8baf45d3360a8dad18d2cabfcff3cb323f7da5901c8cb11ab67622383de49ea
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.7.3

Release files / tracetree-0.1.7-py3-none-any.whl

Download URL tracetree-0.1.7-py3-none-any.whl
Size 10.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f931b2ed32482e8f6236afa78ef478a8b863d66f05e1405c810e550029478f65
BLAKE2b-256 checksum
How to use checksums
bd9f900cd105fbaf06b7cc0f7c017fd05f07c6b666a168220323498ab1e302a2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.7.3

Security for tracetree 0.1.7

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.

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