Metadata-Version: 2.4
Name: mostlyrightmd-core
Version: 2.0.0
Summary: Python SDK core for quants, ML engineers, and AI agents — schema-versioned types, temporal safety, validation, alignment, and snapshot primitives. Domain adapters ship separately; `pip install mostlyrightmd` pulls the full SDK. Imports as `mostlyright`.
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: ai-agents,asos,kalshi,local-first,machine-learning,metar,ml-training,nws,polymarket,prediction-markets,quant-research,quantitative-finance,research,schema-versioned,time-series,weather,weather-data
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Financial and Insurance Industry
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: httpx>=0.27
Requires-Dist: jsonschema>=4.21
Requires-Dist: pandas<4.0,>=2.2
Requires-Dist: tzdata; sys_platform == 'win32'
Provides-Extra: polars
Requires-Dist: narwhals<2.0,>=1.20; extra == 'polars'
Requires-Dist: pandas<4.0,>=2.2; extra == 'polars'
Requires-Dist: polars<2.0,>=1.0; extra == 'polars'
Requires-Dist: pyarrow<24.0,>=17.0; extra == 'polars'
Description-Content-Type: text/markdown

# mostlyrightmd-core

**The public-data SDK core for quants, ML pipelines, and AI agents.**

`mostlyrightmd-core` is the Python core distribution: types, schemas, validators,
temporal-safety primitives, `align()` / `spine()`, and snapshot helpers. Weather,
markets, economy, and finance adapters ship as separate distributions; credentialed
and hosted options belong to their domain packages rather than the core-only
install.

Want the whole SDK in one command? Install the meta-distribution
[`mostlyrightmd`](https://pypi.org/project/mostlyrightmd/), which pulls the core
plus every domain. Individual domains are `mostlyrightmd-weather`,
`mostlyrightmd-markets`, `mostlyrightmd-economy`, and `mostlyrightmd-finance`.

## Install

```bash
pip install mostlyrightmd-core           # core only (helpers + snapshot primitives)
pip install mostlyrightmd                # the FULL SDK (core + weather/markets/economy/finance)
pip install mostlyrightmd-weather        # weather data sources only (brings core transitively)
```

`mostlyrightmd-core` and `mostlyrightmd-weather` share the `mostlyright.*` Python namespace but ship as separate PyPI distributions, so users who only need the helpers can skip the heavier weather deps. `weather.training_table()` lazy-imports `mostlyright.weather` and raises a clear error if the weather package is not installed.

## Point-in-time composition

The core package provides the lower-level `align()` and `spine()` helpers used to
compose targets and sources against per-row cutoffs. They live under
`mostlyright.experimental`: they are documented and usable, but semver-exempt
until they graduate.

Use the domain packages for source reads such as `weather.observations()` and
`economy.series()`. See [`docs/dataset.md`](../../docs/dataset.md) for a complete
composition example.

## Training-table example

If you install the weather package, `training_table()` provides one small,
predefined supervised-learning recipe:

```python
from datetime import date
from mostlyright import weather

table = weather.training_table("KNYC", date(2025, 1, 6), date(2025, 1, 12))
print(table.columns.tolist())
```

Use it when that recipe matches your target. For your own target or sources, use
the composition helpers above. See
[`docs/reference/migration-2.0.md`](../../docs/reference/migration-2.0.md) for
the 2.0 naming changes.

## Documentation

Quickstart, concepts, and the full API reference live at <https://mostlyright.md/docs/sdk/>.
