Skip to main content

Validate required Datasheet, Model Card, and Data Card headings with warning-only PII pattern checks.

Project description

datasheet-ci Python Validator

Validate one local Datasheet, Model Card, or Data Card and receive structured missing-section and PII-pattern evidence.

This Python package is for authors who want the same required-heading lists used by AuraOne Datasheet CI before opening a pull request.

Inspectable Output

The CLI writes JSON with ok, missing, and warning-only piiWarnings for the supplied file.

Runtime Boundary

The CLI reads one local Markdown file and performs local regular-expression checks. It makes no network requests, uploads no document content, and does not determine whether a matched string is actually personal data.

Install and Quickstart

From the datasheet-ci repository root:

python -m pip install ./python_validator
datasheet-ci examples/valid_datasheet.md
datasheet-ci examples/invalid_datasheet.md
datasheet-ci path/to/model-card.md --kind model_card

Release Status

Verified July 13, 2026: datasheet-ci==0.2.1 is published on PyPI and the source is included in the dedicated v0.2.1 repository release.

Limits

This validator checks completeness signals, not factual accuracy, privacy compliance, or documentation quality.

Next Action

Install the validator from python_validator/, run it on the document you plan to submit, add every missing heading, and review each PII-like match manually before opening the pull request.

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

datasheet_ci-0.2.1.tar.gz (3.5 kB view details)

Uploaded Source

Built Distribution

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

datasheet_ci-0.2.1-py3-none-any.whl (3.4 kB view details)

Uploaded Python 3

File details

Details for the file datasheet_ci-0.2.1.tar.gz.

File metadata

  • Download URL: datasheet_ci-0.2.1.tar.gz
  • Upload date:
  • Size: 3.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for datasheet_ci-0.2.1.tar.gz
Algorithm Hash digest
SHA256 177a1fa588f4a589d13e59d81210a68257279a2caa5b2246fa2855b3f78811c7
MD5 19e4adc0156ed5b8fbc4b526093c4aee
BLAKE2b-256 0335051e031e8467324785d7c985499a4d35719964a5ed6dd0a6446f301f69be

See more details on using hashes here.

File details

Details for the file datasheet_ci-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: datasheet_ci-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 3.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for datasheet_ci-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cc1bead17b7300ea0ed5bacc40b2206ebd1721c81433d5210f0d32a5ec651e23
MD5 4059a74d2e7611fa8ae6cf6ecdceaac9
BLAKE2b-256 58e92a89e5eac03cf01f9f79b2643c4433171e03a8d14a037035947204bb8c78

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