Metadata-Version: 2.4
Name: disclosure-alpha
Version: 1.1.0
Summary: Open-source deterministic SEC filing analytics: parse, metrics, diff, score
Project-URL: Homepage, https://disclosure-alpha.readthedocs.io/en/latest/
Project-URL: Documentation, https://disclosure-alpha.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/alwank/disclosure-alpha
Project-URL: Issues, https://github.com/alwank/disclosure-alpha/issues
Project-URL: Changelog, https://github.com/alwank/disclosure-alpha/blob/main/docs/appendix/changelog.md
Author-email: Alwan <alwan.alkautsar@gmail.com>
License: Apache-2.0
License-File: LICENSE
Keywords: 10-k,disclosure,edgar,mcp,nlp,sec
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Office/Business :: Financial
Requires-Python: >=3.11
Requires-Dist: beautifulsoup4>=4.12.0
Requires-Dist: lxml>=5.1.0
Requires-Dist: numpy>=1.26.0
Requires-Dist: scikit-learn>=1.4.0
Requires-Dist: sec-parser<0.59,>=0.58.1
Provides-Extra: api
Requires-Dist: fastapi>=0.110; extra == 'api'
Requires-Dist: pydantic>=2.5.0; extra == 'api'
Requires-Dist: uvicorn[standard]>=0.27; extra == 'api'
Provides-Extra: dev
Requires-Dist: httpx2<3,>=2.4.0; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
Requires-Dist: pytest>=7.4.0; extra == 'dev'
Provides-Extra: mcp
Requires-Dist: mcp>=1.0.0; extra == 'mcp'
Requires-Dist: pydantic>=2.5.0; extra == 'mcp'
Provides-Extra: outcomes
Requires-Dist: yfinance>=0.2.0; extra == 'outcomes'
Provides-Extra: semantic
Requires-Dist: sentence-transformers>=2.2.0; extra == 'semantic'
Provides-Extra: validation
Requires-Dist: spacy>=3.7.0; extra == 'validation'
Description-Content-Type: text/markdown

# Disclosure Alpha

![Disclosure Alpha](https://raw.githubusercontent.com/alwank/disclosure-alpha/main/docs/assets/readme-hero.png)

**Deterministic SEC filing analytics — parse, score, diff. No LLM required.**

[![PyPI](https://img.shields.io/pypi/v/disclosure-alpha.svg)](https://pypi.org/project/disclosure-alpha/)
[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
[![License: Apache-2.0](https://img.shields.io/badge/License-Apache--2.0-green.svg)](LICENSE)
[![Documentation](https://readthedocs.org/projects/disclosure-alpha/badge/?version=latest)](https://disclosure-alpha.readthedocs.io/en/latest/)

Open-source, deterministic SEC filing analytics for **10-K, 10-Q, and 8-K** HTML. Reproducible JSON scores from text metrics, boolean risk flags, and section diffs. CLI, Python SDK, HTTP API, and MCP.

**Not investment advice.** See [Scope and claims](https://disclosure-alpha.readthedocs.io/en/latest/getting-started/scope-and-claims.html) and [Evidence & limitations](https://disclosure-alpha.readthedocs.io/en/latest/validation/evidence-and-limitations.html).

## Quick start

```bash
pip install "disclosure-alpha"
export SEC_USER_AGENT="YourName your@email.com"   # required for --ticker / EDGAR only
disclosure-alpha score --ticker AAPL --fiscal-year 2025 --form 10-K
```

HTTP API + MCP: `pip install "disclosure-alpha[api,mcp]"`

```python
from disclosure_alpha import score_filing_ticker
print(score_filing_ticker("AAPL", 2025, form_type="10-K").scores.overall_disclosure_risk_score)
```

## Integration surfaces

| Surface | Entry | Extra |
|---------|-------|-------|
| CLI | `disclosure-alpha` | *(base)* |
| Python SDK | `import disclosure_alpha` | *(base)* |
| HTTP API | `disclosure-alpha-api` | `[api]` |
| MCP Analyst | `disclosure-alpha-mcp-analyst` | `[mcp]` |
| MCP Builder | `disclosure-alpha-mcp-builder` | `[mcp]` |

## Documentation

Full guides, methodology, and validation evidence: **https://disclosure-alpha.readthedocs.io/en/latest/**

- [Installation](https://disclosure-alpha.readthedocs.io/en/latest/getting-started/installation.html)
- [Understanding scores](https://disclosure-alpha.readthedocs.io/en/latest/getting-started/understanding-scores.html)
- [HTTP API](https://disclosure-alpha.readthedocs.io/en/latest/guides/http/index.html)
- [MCP](https://disclosure-alpha.readthedocs.io/en/latest/guides/mcp/index.html)

## Links

- **Repository:** https://github.com/alwank/disclosure-alpha
- **Changelog:** https://github.com/alwank/disclosure-alpha/blob/main/docs/appendix/changelog.md
- **Contributing:** https://github.com/alwank/disclosure-alpha/blob/main/CONTRIBUTING.md

Apache-2.0. See [LICENSE](LICENSE).
