pydantic-market-data 0.1.16

Shared models and interfaces for finance datasources

pydantic-market-data

Shared Pydantic models and interfaces for financial data sources. Defines a standard contract (DataSource) and data structures (OHLCV, Symbol, History) to interoperability between finance packages.

Installation

pip install pydantic-market-data

Usage

Models

Standardized data models for financial entities.

from pydantic_market_data.models import Symbol, OHLCV, History, SecurityCriteria, Ticker

# Symbol Definition
s = Symbol(
    ticker="AAPL",
    name="Apple Inc.",
    exchange="NASDAQ",
    currency="USD"
)

# Historical Data Point
candle = OHLCV(
    date="2023-12-01", # Coerced to FlexibleDatetime
    open=150.0,
    high=155.0,
    low=149.0,
    close=154.0,
    volume=50000000
)

# Security Lookup Criteria
criteria = SecurityCriteria(
    symbol="AAPL",
    target_date="2023-12-01" # Coerced to FlexibleDate
)

Protocol

Implement the DataSource protocol to create compatible data providers.

from typing import Optional, List
from pydantic_market_data.interfaces import DataSource
from pydantic_market_data.models import SecurityCriteria, Symbol, History, Ticker, HistoryPeriod

class MySource(DataSource):
    def resolve(self, criteria: SecurityCriteria) -> Optional[Symbol]:
        # Implementation...
        pass

    def history(self, ticker: Ticker | str, period: HistoryPeriod = HistoryPeriod.MO1) -> History:
        # Implementation...
        pass

    def search(self, query: str) -> List[Symbol]:
        # Implementation...
        pass

CLI Support

The package provides optimized pydantic-settings models for building professional CLI tools.

from pydantic_market_data.cli_models import SearchArgs, PatchedCliSettingsSource
from pydantic_settings import BaseSettings

class MyCliSettings(BaseSettings):
    search: SearchArgs

    @classmethod
    def settings_customise_sources(cls, settings_cls, **kwargs):
        return (PatchedCliSettingsSource(settings_cls),)

# Usage:
# my-tool search --ticker AAPL --vv --format json

Key CLI features:

• Clean Help: Automatically removes default values from help text for a cleaner look.
• Improved Flags: Normalizes double-dash flags like --vv to -vv.
• JSON Schema: Adds a --schema flag to output the interface definition.
• Metavars: Custom types (SYMBOL, ISIN, etc.) provide descriptive help labels.

License

MIT