22
33This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
44
5- ## Project Status: v2 .0.4 - Async Architecture
5+ ## Project Status: v3 .0.1 - Production-Ready Async Architecture
66
7- ** IMPORTANT** : This project has migrated to a fully asynchronous architecture as of v2.0.0. All APIs are now async-only with no backward compatibility to synchronous versions .
7+ ** IMPORTANT** : This project uses a fully asynchronous architecture. All APIs are async-only, optimized for high-performance futures trading .
88
99## Development Phase Guidelines
1010
@@ -74,7 +74,7 @@ uv run python -m build # Alternative build command
7474
7575## Project Architecture
7676
77- ### Core Components (v2 .0.4 - Multi-file Packages)
77+ ### Core Components (v3 .0.1 - Multi-file Packages)
7878
7979** ProjectX Client (` src/project_x_py/client/ ` )**
8080- Main async API client for TopStepX ProjectX Gateway
@@ -93,11 +93,17 @@ uv run python -m build # Alternative build command
9393 - ` bracket_orders.py ` : OCO and bracket order logic
9494 - ` position_orders.py ` : Position-based order management
9595 - ` tracking.py ` : Order state tracking
96+ - ` templates.py ` : Order templates for common strategies
9697- ` PositionManager ` (` position_manager/ ` ): Async position tracking and risk management
9798 - ` core.py ` : Position management core
9899 - ` risk.py ` : Risk calculations and limits
99100 - ` analytics.py ` : Performance analytics
100101 - ` monitoring.py ` : Real-time position monitoring
102+ - ` tracking.py ` : Position lifecycle tracking
103+ - ` RiskManager ` (` risk_manager/ ` ): Integrated risk management
104+ - ` core.py ` : Risk limits and validation
105+ - ` monitoring.py ` : Real-time risk monitoring
106+ - ` analytics.py ` : Risk metrics and reporting
101107- ` ProjectXRealtimeDataManager ` (` realtime_data_manager/ ` ): Async WebSocket data
102108 - ` core.py ` : Main data manager
103109 - ` callbacks.py ` : Event callback handling
@@ -126,6 +132,13 @@ uv run python -m build # Alternative build command
126132- Environment variable based configuration
127133- JSON config file support (` ~/.config/projectx/config.json ` )
128134- ProjectXConfig dataclass for type safety
135+ - ConfigManager for centralized configuration handling
136+
137+ ** Event System**
138+ - Unified EventBus for cross-component communication
139+ - Type-safe event definitions
140+ - Async event handlers with priority support
141+ - Built-in event types for all trading events
129142
130143### Architecture Patterns
131144
@@ -265,23 +278,49 @@ async with ProjectX.from_env() as client:
265278
266279## Recent Changes
267280
281+ ### v3.0.1 - Production Ready
282+ - ** Performance Optimizations** : Enhanced connection pooling and caching
283+ - ** Event Bus System** : Unified event handling across all components
284+ - ** Risk Management** : Integrated risk manager with position limits and monitoring
285+ - ** Order Tracking** : Comprehensive order lifecycle tracking and management
286+ - ** Memory Management** : Optimized sliding windows and automatic cleanup
287+ - ** Enhanced Models** : Improved data models with better type safety
288+
289+ ### v3.0.0 - Major Architecture Improvements
290+ - ** Trading Suite** : Unified trading suite with all managers integrated
291+ - ** Advanced Order Types** : OCO, bracket orders, and position-based orders
292+ - ** Real-time Integration** : Seamless WebSocket data flow across all components
293+ - ** Protocol-based Design** : Type-safe protocols for all major interfaces
294+
268295### v2.0.4 - Package Refactoring
269- - ** Major Architecture Change** : Converted monolithic modules to multi-file packages
270- - All core modules now organized as packages with focused submodules
271- - Improved code organization, maintainability, and testability
272- - Backward compatible - all imports work as before
273-
274- ### v2.0.2 - Pattern Recognition Indicators
275- - Added Fair Value Gap (FVG) indicator for price imbalance detection
276- - Added Order Block indicator for institutional zone identification
277- - Added Waddah Attar Explosion for volatility-based trend strength
278- - All indicators support async data processing
279-
280- ### v2.0.0 - Complete Async Migration
281- - ** Breaking Change** : Entire SDK migrated to async-only architecture
282- - All methods now require ` await ` keyword
283- - Context managers for proper resource management
284- - No synchronous fallbacks or compatibility layers
296+ - Converted monolithic modules to multi-file packages
297+ - All core modules organized as packages with focused submodules
298+ - Improved code organization and maintainability
299+
300+ ### Trading Suite Usage
301+ ``` python
302+ # Complete trading suite with all managers
303+ from project_x_py import create_trading_suite
304+
305+ async def main ():
306+ suite = await create_trading_suite(
307+ instrument = " MNQ" ,
308+ timeframes = [" 1min" , " 5min" ],
309+ enable_orderbook = True ,
310+ enable_risk_management = True
311+ )
312+
313+ # All managers are integrated and ready
314+ await suite.start()
315+
316+ # Access individual managers
317+ order = await suite.order_manager.place_market_order(
318+ " MNQ" , 1 , " BUY"
319+ )
320+
321+ position = suite.position_manager.get_position(" MNQ" )
322+ bars = suite.data_manager.get_bars(" MNQ" , " 1min" )
323+ ```
285324
286325### Key Async Examples
287326``` python
0 commit comments