Skip to content

quillmark-open-source/compliance-flag

Compliance Flag

CI Python 3.10+ License: Apache-2.0 Ruff Status: alpha

Compliance Flag is a Python CLI for creating reviewer-ready reports on public URLs and local content files a team is authorized to review.

It helps teams capture source material, compare RIA marketing content with bundled regulatory sources, and prepare structured reports for qualified compliance, legal, or supervisory review.

Project Links: Documentation | Usage | Roadmap | Changelog | Contributing | Security

Status

Compliance Flag is moving from alpha to beta. The current package scaffold includes:

  • compliance-flag scan --file for local .html, .htm, .md, and .txt files
  • experimental compliance-flag scan --url support that captures page content before analysis
  • structured JSON reports validated against a bundled schema
  • HTML report rendering
  • saved raw source files and source metadata alongside each report
  • bundled prompt, schema, and regulatory source assets migrated from the alpha scanner

Install

python -m pip install compliance-flag

Or with pipx:

pipx install compliance-flag

Set an Anthropic API key before running scans:

export ANTHROPIC_API_KEY="..."

Usage

Scan a local file:

compliance-flag scan --file tests/fixtures/example-blog-post.html

Scan an authorized public URL:

compliance-flag scan --url https://example.com

Write output to a specific directory:

compliance-flag scan --file page.html --out reports/example

Each scan writes:

  • a JSON report
  • an HTML report
  • a raw captured source file, such as .source.html
  • a source metadata file, .source-meta.json

Intended Use

Compliance Flag is a review-support tool. It is not a compliance approval system, legal reviewer, or substitute for qualified professional judgment.

Only use Compliance Flag on websites, files, pages, or other content that you own, control, administer, or have explicit permission to assess. Do not run URL scans against third-party websites without authorization.

The initial project focus is SEC Rule 275.206(4)-1, Investment adviser marketing. Related SEC sources may be used as supporting context where appropriate.

Development

pytest
ruff check .
python -m build

Maintainer

Compliance Flag is a Quillmark Open Source project maintained by Quillmark LLC.

License

Apache-2.0. See LICENSE.

Disclaimer

See DISCLAIMER.md.