Metadata-Version: 2.4
Name: mostlyrightmd-finance
Version: 4.1.1
Summary: Finance data for Python — earnings-call transcript capture, streaming transcription, fact ledgers, and prediction-market earnings-mention resolution (Kalshi KXEARNINGSMENTION / Polymarket 'will <co> say <word>'). Local-first on-device capture + STT with a legal audio firewall (audio is transient, never served). Imports as `mostlyright.finance`.
Project-URL: Homepage, https://mostlyright.md
Project-URL: Documentation, https://mostlyright.md/docs/sdk/
Project-URL: Repository, https://github.com/mostlyrightmd/mostlyright-sdk
Project-URL: Issues, https://github.com/mostlyrightmd/mostlyright-sdk/issues
Project-URL: Changelog, https://github.com/mostlyrightmd/mostlyright-sdk/blob/main/CHANGELOG.md
Author-email: Robert Tarabcak <tarabcakr@gmail.com>
License-Expression: MIT
Keywords: backtesting,earnings,earnings-call,earnings-mention,finance,kalshi,ml-training-data,point-in-time,polymarket,prediction-markets,settlement,transcripts
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.11
Requires-Dist: filelock>=3.12
Requires-Dist: httpx>=0.27
Requires-Dist: jsonschema>=4.21
Requires-Dist: mostlyrightmd-core<4.2.0,>=4.1.1
Requires-Dist: pyarrow<24.0,>=17.0
Requires-Dist: tzdata; sys_platform == 'win32'
Provides-Extra: parquet
Requires-Dist: pandas<4.0,>=2.2; extra == 'parquet'
Provides-Extra: transcripts
Requires-Dist: av<18.0,>=11.0; extra == 'transcripts'
Requires-Dist: faster-whisper<2.0,>=1.0; extra == 'transcripts'
Requires-Dist: pandas<4.0,>=2.2; extra == 'transcripts'
Description-Content-Type: text/markdown

# mostlyrightmd-finance

Finance data for the `mostlyright` Python SDK — earnings-call transcript capture,
streaming transcription, append-only fact ledgers, and prediction-market
earnings-mention resolution (Kalshi `KXEARNINGSMENTION{TICKER}` + Polymarket
"will <co> say <word>"). Local-first on-device capture + STT with a legal audio
firewall: captured audio is a **transient** artifact — only transcript text and
derived facts survive. Imports as `mostlyright.finance`.

The transcript engine, hosted and live adapters, SSE stream,
Kalshi/Polymarket resolver, and point-in-time helpers live under
`mostlyright.finance.transcripts`.

Source addresses resolve through the hosted manifest catalog, which requires
`MOSTLYRIGHT_API_KEY` (subscriptions at <https://app.mostlyright.md>).

## Install

```bash
pip install mostlyrightmd-finance                 # ledger + resolver
pip install 'mostlyrightmd-finance[transcripts]'  # + faster-whisper + av (capture/STT)
```

## Public API

The pipeline lives at `mr.finance.transcripts`:

- **Engine** — `CaptureAdapter` / `Q4CaptureAdapter`, `StreamingTranscriber` /
  `SttTranscriber`, `SegmentBus`, and the append-only `FactLedger` /
  `TranscriptLedger`.
- **Adapter + stream** — the `EarningsAdapter` consumer/parser and the SSE
  `consume_sse` reader.
- **Market resolution** — `resolve` (Kalshi / Polymarket earnings-mention),
  `derive` / `detect_provider`, the codegen registries + calendar seed, and the
  point-in-time helpers (`knowledge_time` = transcript availability).

`mr.finance` exposes **no** `training_table()` — there are no
settlement labels yet. Use the transcript rows and point-in-time helpers directly
for research.

## Docs

See [`docs/finance-transcripts.md`](../../docs/finance-transcripts.md) and
<https://mostlyright.md/docs/sdk/> for the quickstart and the full API reference.
