Skip to content
Mostly Right

Packages & versioning

Mostly Right ships publicly for Python and TypeScript. One meta-package installs all common methods; per-domain packages let you depend on only what you use.

Install everything

Section titled “Install everything”
Terminal window
pip install mostlyrightmd
Terminal window
pnpm add mostlyright

The Python import name is mostlyright. Support floors are Python 3.11+ and Node 20+.

Packages

Section titled “Packages”
DomainPythonTypeScript
Core / metamostlyrightmdmostlyright / @mostlyrightmd/core
Weathermostlyrightmd-weather@mostlyrightmd/weather
Marketsmostlyrightmd-markets@mostlyrightmd/markets
Economymostlyrightmd-economy@mostlyrightmd/economy
Financemostlyrightmd-finance@mostlyrightmd/finance

All packages share the mostlyright namespace and follow the same schema and source-identity conventions. Inspect each runtime’s returned schema before freezing a cross-runtime model contract.

The 2.0 API

Section titled “The 2.0 API”

Version 2.0 is a hard naming break:

  • observations() returns archived weather reports.
  • series(), snapshot(), and venue namespaces expose direct domain data.
  • Date windows use from_date / to_date; time windows use from_time / to_time.
  • return_type="dataframe" replaces as_dataframe=True.
  • Python and TypeScript use the same snake_case schema vocabulary.
  • training_table() is a small built-in recipe for common supervised examples.

The removed 1.x names (research(), pairs(), dataset(), and obs()) do not have compatibility shims in 2.0.

Runtime model

Section titled “Runtime model”

Most methods fetch public APIs directly and need no account or API key. Python can cache under ~/.mostlyright/cache/, Node under ~/.mostlyright/cache-ts/, and browser builds use IndexedDB. Hosted methods use MOSTLYRIGHT_* environment variables when configured.

Where next

Section titled “Where next”