Skip to main content

pydantic-market-data

PyPI version License: MIT CI Status

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

Installation

pip install pydantic-market-data

Usage

Models

Standardized data models for financial entities.

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

# Security Definition
s = Security(
    symbol="AAPL",
    name="Apple Inc.",
    exchange="NASDAQ",
    currency="USD",
    asset_class="Equity",
    isin="US0378331005"
)

# 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",
    asset_class="Equity",
    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, Security, History, Symbol, HistoryPeriod

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

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

    def search(self, query: str) -> List[Security]:
        # 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 --symbol 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.

SearchArgs and HistoryArgs are SecurityQueryArgs and HistoryQueryArgs plus GlobalArgs (-v, -vv, --format, --schema). If your CLI framework already owns those options, use the domain-only *QueryArgs models instead:

from pydantic_market_data import SecurityQueryArgs

class SearchCommand(SecurityQueryArgs):
    pass  # --symbol, --isin, ... without -v/--format/--schema

License

MIT

Metadata

Release files for pydantic-market-data 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pydantic-market-data 0.5.0
File Size Uploaded
pydantic_market_data-0.5.0.tar.gz 20.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pydantic-market-data 0.5.0
File Interpreter ABI Platform
pydantic_market_data-0.5.0-py3-none-any.whl Python 3 none any Details

Total release size: 31.5 kB

Release files / pydantic_market_data-0.5.0.tar.gz

Download URL pydantic_market_data-0.5.0.tar.gz
Size 20.7 kB
Tags Source
SHA-256 checksum
How to use checksums
832cab6671e3fe883dc5a3cc916097e311eb41309d95ca194c30866b4b20474b
BLAKE2b-256 checksum
How to use checksums
a46b058e7252b1e1d62438123af83fe51c9d871b6d44a068ad7e8116a5188526
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.21 {"installer":{"name":"uv","version":"0.12.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / pydantic_market_data-0.5.0-py3-none-any.whl

Download URL pydantic_market_data-0.5.0-py3-none-any.whl
Size 10.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3cf19d7bcacf44f6e8682ae5b60d3dfd6944e169710cb7cecf2f0c2ddd9ad052
BLAKE2b-256 checksum
How to use checksums
39ba59d8c418dc34acd270f2530721328307e4a462d69e702287fcfa320001bb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.21 {"installer":{"name":"uv","version":"0.12.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

0.9.0

2 release files

0.8.0

2 release files

0.7.0

2 release files

0.6.1

2 release files

0.6.0

2 release files

This release

0.5.0 This release

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.16

2 release files

0.1.15

2 release files

0.1.14

2 release files

0.1.13

2 release files

0.1.11

2 release files

0.1.10

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page