Skip to main content

sot-validator

Validator for Source of Truth (.sot) files — epistemic quality verification for AI-safe documentation.

PyPI version License: CC BY 4.0

What is a .sot file?

A Source of Truth (.sot) file is a markdown document structured to communicate explicit confidence levels for all claims, enabling readers (human or AI) to calibrate their trust appropriately.

Part of the Clarity Gate ecosystem for epistemic quality verification.

Installation

pip install sot-validator

CLI Usage

# Validate a single file
sot-validator project.sot

# Validate multiple files
sot-validator docs/*.sot

# Output as JSON
sot-validator project.sot --json

# Quiet mode (errors only)
sot-validator project.sot -q

Python API

from sot_validator import validate, is_valid, detect, validate_file

# Full validation with errors and warnings
result = validate(file_content)
print(result.valid)     # bool
print(result.errors)    # list of ValidationError
print(result.warnings)  # list of ValidationError

# Quick check
if is_valid(file_content):
    print('Document passes validation')

# Detect if content is .sot format
if detect(file_content):
    print('This appears to be a .sot file')

# Validate from file path
result = validate_file('project.sot')

Validation Rules

Required Elements

  • -- Source of Truth header
  • **Last Updated:** field
  • **Owner:** field
  • **Status:** field
  • ## Verification Status section

Warnings

  • Unqualified "VERIFIED" status (should be "with noted exceptions")
  • Estimates in Verified Data section
  • Missing staleness markers ([STABLE], [VOLATILE], etc.)

Related

File Format Specification

See the SOT and CGD File Format Specification.

License

CC BY 4.0 — Use freely with attribution.

Author

Francesco Marinoni Moretto
GitHub: @frmoretto

Metadata

Release files for sot-validator 0.1.1

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

Source distribution (sdist)

Source distribution for sot-validator 0.1.1
File Size Uploaded
sot_validator-0.1.1.tar.gz 4.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sot-validator 0.1.1
File Interpreter ABI Platform
sot_validator-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 10.1 kB

Release files / sot_validator-0.1.1.tar.gz

Download URL sot_validator-0.1.1.tar.gz
Size 4.5 kB
Tags Source
SHA-256 checksum
How to use checksums
bff564629b8386827cdf11b4e52c7a746f0ab6e6d75e3f4a05b354d4782a2972
BLAKE2b-256 checksum
How to use checksums
2a23ecb83599bbd1a73eff3ab59b498d20b08722a078e083f1e86ce7d5283bf6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.2

Release files / sot_validator-0.1.1-py3-none-any.whl

Download URL sot_validator-0.1.1-py3-none-any.whl
Size 5.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
add6bf5e1ea6f71edffb73805d847de28eb20e750e7f83aa28fc6576a10928e2
BLAKE2b-256 checksum
How to use checksums
461bd1886a27b83ce7718d5987c4863c7ec6fc851001cbf417354202eee03b78
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.2

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files

0.1.0

2 release files

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