Python CLI for flagging potential SEC Marketing Rule issues in authorized public URLs and local files.
Project description
Compliance Flag
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 --filefor local.html,.htm,.md, and.txtfiles- experimental
compliance-flag scan --urlsupport 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 For Development
python -m venv .venv
source .venv/bin/activate
python -m pip install -e ".[dev]"
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file compliance_flag-0.1.0.tar.gz.
File metadata
- Download URL: compliance_flag-0.1.0.tar.gz
- Upload date:
- Size: 356.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f2a8ea1156ab93e59b9361d0bac4344716713442babe7a9a12bc40af8c284f09
|
|
| MD5 |
727a97fb77e443d28f6d818f16505d57
|
|
| BLAKE2b-256 |
97a172a54d5d7436d204d9eac7d650afb1c57624bbe68108af8015794c523cef
|
Provenance
The following attestation bundles were made for compliance_flag-0.1.0.tar.gz:
Publisher:
release.yml on quillmark-open-source/compliance-flag
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
compliance_flag-0.1.0.tar.gz -
Subject digest:
f2a8ea1156ab93e59b9361d0bac4344716713442babe7a9a12bc40af8c284f09 - Sigstore transparency entry: 1501215827
- Sigstore integration time:
-
Permalink:
quillmark-open-source/compliance-flag@fce092d952b07652706756a28707d7e0056a9191 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/quillmark-open-source
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@fce092d952b07652706756a28707d7e0056a9191 -
Trigger Event:
release
-
Statement type:
File details
Details for the file compliance_flag-0.1.0-py3-none-any.whl.
File metadata
- Download URL: compliance_flag-0.1.0-py3-none-any.whl
- Upload date:
- Size: 52.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
249a46ed7f3d51e3f110f65e2f2acb1143867a0d801df142fe3c1450c5e4652f
|
|
| MD5 |
8ba189ac66092cab172aa64a14c911b2
|
|
| BLAKE2b-256 |
392355657318ecf89989ebbc2c679ac81bd78df295e4469797760f2bd1551792
|
Provenance
The following attestation bundles were made for compliance_flag-0.1.0-py3-none-any.whl:
Publisher:
release.yml on quillmark-open-source/compliance-flag
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
compliance_flag-0.1.0-py3-none-any.whl -
Subject digest:
249a46ed7f3d51e3f110f65e2f2acb1143867a0d801df142fe3c1450c5e4652f - Sigstore transparency entry: 1501215962
- Sigstore integration time:
-
Permalink:
quillmark-open-source/compliance-flag@fce092d952b07652706756a28707d7e0056a9191 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/quillmark-open-source
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@fce092d952b07652706756a28707d7e0056a9191 -
Trigger Event:
release
-
Statement type: