Skip to main content

Universal traceability validation and rollup for requirements-to-tests mapping.

Project description

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 validate
tracetree link
tracetree aggregate

Expected Structure (Defaults)

  • docs/traceability/requirements.md
  • docs/traceability/risk_controls.md
  • docs/traceability/traceability_matrix.csv

Test discovery defaults:

  • GTest: tests/, test/
  • Pytest: tests/, test/

Repo Configuration

Create .traceability/config.json to override defaults:

{
  "traceability_dir": "docs/traceability",
  "requirements_file": "requirements.md",
  "risk_controls_file": "risk_controls.md",
  "matrix_file": "traceability_matrix.csv",
  "gtest_roots": ["tests"],
  "pytest_roots": ["bindings/python/tests"]
}

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/aggregate/traceability_rollup.md.

Project details


Download files

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

Source Distribution

tracetree-0.1.0.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

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

tracetree-0.1.0-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tracetree-0.1.0.tar.gz
  • Upload date:
  • Size: 7.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.3

File hashes

Hashes for tracetree-0.1.0.tar.gz
Algorithm Hash digest
SHA256 5eaef4ecab04cdec5f73f34d19bb2e2f8316a1b9ec053e87175216c94aa64d1d
MD5 5a93398b64c24727dd00f65ec97beb86
BLAKE2b-256 033dbc947b73dd5f4e4023802c461c2c2d4db1b97c2b268cc7ae6de66b1a7098

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tracetree-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.3

File hashes

Hashes for tracetree-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0126c515dd2821e6f69d44efdabc9753f79198351d259f7639168c8dddff229e
MD5 8691ff468df3c45ebfe4153ad0bdf787
BLAKE2b-256 3575e1d6d83540b7b7534e1e30f93953b4a1e2da132486da8a0ccbf145df9bf4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page