Skip to content

SDK Reference

Auto-generated Python SDK documentation from source code docstrings.

Libraries

Library Description Import
tradai-common Base classes, entities, exceptions, AWS utilities from tradai.common import ...
tradai-data Data fetching, storage adapters, OHLCV handling from tradai.data import ...
tradai-strategy Strategy framework, validation, metadata from tradai.strategy import ...

Quick Start

# Common utilities
from tradai.common import (
    BaseService,
    LoggerMixin,
    BacktestConfig,
    BacktestResult,
    ValidationError,
)

# Data handling
from tradai.data import (
    OHLCVRepository,
    ExchangeDataSource,
    ArcticDBAdapter,
)

# Strategy development
from tradai.strategy import (
    TradAIStrategy,
    StrategyMetadata,
    ValidationResult,
)

Architecture

tradai-common           Base layer - shared across all components
    │
    ├── tradai-data     Data layer - fetching and storage
    │
    └── tradai-strategy Strategy layer - execution and validation

Conventions

All libraries follow these conventions:

  • Pydantic Models: All entities use BaseModel with frozen=True
  • Protocols: Interfaces defined with typing.Protocol
  • Dependency Injection: Constructor injection with optional defaults
  • Logging: Use LoggerMixin for consistent logging
  • Exceptions: Custom exceptions inherit from TradAIError

See Also