Installation¶
Install Disclosure Alpha with Python 3.11+.
From PyPI¶
Install from PyPI:
pip install "disclosure-alpha"
HTTP API and MCP together:
pip install "disclosure-alpha[api,mcp]"
Pin a release when reproducibility matters — see Versioning and Reproducibility:
pip install "disclosure-alpha==1.4.0[api,mcp]"
Optional extras¶
Extra |
Purpose |
|---|---|
(base) |
CLI + Python SDK |
|
HTTP API ( |
|
MCP servers for Cursor / Claude Desktop |
|
MiniLM embeddings (default pipeline uses TF-IDF) |
pip install "disclosure-alpha[api]"
pip install "disclosure-alpha[mcp]"
pip install "disclosure-alpha[api,mcp]"
Contributor-only extras
Extra |
Purpose |
|---|---|
|
pytest tooling |
|
Construct-validity harness (spaCy) |
|
Post-filing outcome fetch (yfinance; contributor tooling) |
pip install -e ".[api,mcp,dev,validation,outcomes]"
See CONTRIBUTING.md in the repository.
From source (contributors)¶
git clone https://github.com/alwank/disclosure-alpha.git
cd disclosure-alpha
pip install -e ".[api,mcp,dev]"
Verify entry points¶
disclosure-alpha --help
disclosure-alpha-api --help # requires [api]
disclosure-alpha-mcp-analyst --help # requires [mcp]
Next steps¶
After install, run the exact commands in First Successful Run.
SEC EDGAR Setup — required for ticker-based commands
FAQ and Troubleshooting — common errors and fixes
Quickstart: CLI — score from the terminal
Quickstart: Python API — score from Python
Choose Your Surface — pick CLI, Python, HTTP, or MCP