v3.1.0

[TexasCoding]

ProjectX Python SDK v3.1.0 - High-Performance Production Suite

🚀 Major Performance Release

We're excited to announce v3.1.0, a major performance-focused release that delivers 2-5x improvements across the board while maintaining the simplicity of our unified TradingSuite interface. This release represents months of optimization work, bringing enterprise-grade performance to algorithmic trading on the ProjectX platform.

⚡ Performance Highlights

Benchmark Results

• API Response Time: 30-50% faster with optimized connection pooling
• Memory Usage: 40-60% reduction with automatic overflow to disk
• WebSocket Processing: 2-3x throughput increase with message batching
• DataFrame Operations: 20-40% faster with optimized Polars chains
• JSON Operations: 2-3x faster with orjson integration
• Cache Hit Rate: 85-90% (up from 60%) with advanced caching

🎯 Key Features

Memory-Mapped Overflow Storage

Automatic overflow to disk when memory limits are reached, enabling:

• Seamless handling of large datasets without memory constraints
• Transparent access combining in-memory and disk storage
• Configurable overflow thresholds (default 80% of max bars)
• Zero code changes required - works automatically

orjson Integration

• 2-3x faster JSON serialization/deserialization
• Automatic fallback to standard json if unavailable
• Significant performance boost for API responses and caching

WebSocket Message Batching

• Configurable batch size and timeout parameters
• Automatic batching for quotes, trades, and depth updates
• 2-3x throughput increase for real-time data processing
• Built-in performance statistics tracking

Advanced Caching System

• msgpack binary serialization for 2-5x faster cache operations
• lz4 compression for data >1KB (70% size reduction)
• LRU cache for instruments (max 1000 items)
• TTL cache for market data with configurable expiry

💻 Installation

Using UV (Recommended)

uv add project-x-py==3.1.0

Using pip

pip install project-x-py==3.1.0

🔥 Quick Start

import asyncio
from project_x_py import TradingSuite, EventType

async def main():
    # One-line initialization with all performance optimizations
    suite = await TradingSuite.create(
        "MNQ",
        timeframes=["1min", "5min"],
        features=["orderbook", "risk_manager"]
    )
    
    # Register event handlers
    @suite.events.on(EventType.NEW_BAR)
    async def on_new_bar(event):
        print(f"New {event.data['timeframe']} bar: ${event.data['close']:.2f}")
    
    # Access high-performance components
    data = await suite.data.get_data("5min")  # Automatic memory management
    orderbook = suite.orderbook  # Optimized Level 2 processing
    
    # Trading with enterprise performance
    response = await suite.orders.place_limit_order(
        contract_id=suite.instrument.id,
        side=0,  # Buy
        size=1,
        limit_price=21050.0
    )
    
    await suite.disconnect()

asyncio.run(main())

📊 What's New

Performance Optimizations (75% Complete)

✅ Phase 1-3: Complete

• uvloop integration for 2-4x faster async operations
• HTTP connection pooling optimizations
• slots implementation for 40% memory reduction
• Deque replacement for O(1) sliding windows
• DataFrame operation chaining

🚧 Phase 4: 75% Complete (This Release)

• ✅ Memory-mapped overflow storage
• ✅ orjson integration
• ✅ WebSocket message batching
• ✅ Advanced caching with compression
• ⏳ Cython compilation (coming in v3.2)
• ⏳ Protocol buffers (coming in v3.2)

Technical Improvements

• Comprehensive test coverage for all optimized components
• Full mypy type compliance
• All ruff checks pass
• Cleaned up legacy compatibility code
• macOS-compatible mmap resizing implementation

📈 Trading Features

58+ Technical Indicators

Including new pattern recognition indicators:

• Fair Value Gap (FVG): Price imbalance detection
• Order Block: Institutional order zone identification
• Waddah Attar Explosion (WAE): Volatility-based trend strength

Unified TradingSuite Interface

• Single entry point for all components
• Automatic dependency management
• Built-in connection handling
• Feature flags for optional components

Enterprise Features

• Level 2 OrderBook with iceberg detection
• Multi-timeframe data management
• Risk management with position limits
• Comprehensive order lifecycle tracking
• Real-time WebSocket streaming

🔄 Migration from v3.0

Minimal changes required - existing TradingSuite code works as-is:

# v3.0 and v3.1 - Same interface!
suite = await TradingSuite.create("MNQ")

All performance optimizations are automatic - no code changes needed.

📚 Documentation

• Full Documentation
• API Reference
• Performance Guide
• Examples

🐛 Bug Fixes

• Fixed asyncio concurrency issues in order lifecycle tracking
• Corrected instrument lookup to use cached objects
• Fixed Order/Position field references
• Improved cleanup functionality for demos

📦 Dependencies Added

• orjson: High-performance JSON library
• msgpack-python: Binary serialization
• lz4: Fast compression
• cachetools: Advanced caching utilities

🙏 Acknowledgments

Thanks to all contributors who helped make this performance release possible. Special thanks to the community for testing and feedback.

⚠️ Important Notes

• This SDK is for educational and development purposes
• Trading futures involves substantial risk of loss
• Always test strategies thoroughly before using real funds
• Performance improvements are most noticeable with high-frequency data

🔮 What's Next (v3.2 Preview)

• Complete Phase 4 optimizations (Cython, Protocol Buffers)
• Phase 5: Monitoring and observability improvements
• Additional exchange support
• Enhanced backtesting capabilities
• Machine learning integration helpers

---

Full Changelog: https://github.com/TexasCoding/project-x-py/blob/main/CHANGELOG.md

Report Issues: https://github.com/TexasCoding/project-x-py/issues

PyPI Package: https://pypi.org/project/project-x-py/3.1.0/

---

This discussion was created from the release v3.1.0.