How uberdeveloper/omspy works
Main Components
A. Core System Layer:
• Base Components (/omspy/base.py, models.py)
• Order Management (/omspy/order.py)
• Multi-broker Support (/omspy/multi.py)
• Utility Functions (/omspy/utils.py)
B. Broker Integration Layer (/omspy/brokers/):
• Multiple Broker Implementations:
• Finvasia
• ICICI
• Neo
• Noren
• Paper Trading
• Zerodha
• API Helper Module
C. Advanced Order Types Layer (/omspy/orders/):
• Depth-based Orders
• Pegged Orders
• Stop Orders
D. Algorithm Layer (/omspy/algos/):
• Straddle Implementation
• Trailing Orders
E. Simulation System (/omspy/simulation/):
• Virtual Trading Environment
• Simulation Models
• Simulation Server
┌─────────────────────────────────────────────────────┐
• Client Applications │
• ┘
• ↑
┌─────────────────────────────────────────────────────┐
• Algorithm Layer │
• (Straddle, Trailing, Custom Implementations) │
• ┘
• ↑
┌─────────────────────────────────────────────────────┐
• Advanced Order Types │
• (Depth, Peg, Stop Order Handlers) │
• ┘
• ↑
┌─────────────────────────────────────────────────────┐
• Core OMS Layer │
• (Order Management, Models, Multi-broker Support) │
• ┘
• ↑
┌─────────────────────────────────────────────────────┐
• Broker Integration Layer │
• (Multiple Broker Implementations + API Helper) │
• ┘
• ↑
┌─────────────────────────────────────────────────────┐
• External Broker APIs │
• ┘
Important Elements to Highlight
A. Data Flow Patterns:
• How orders flow from algorithms through the core system to brokers
• How market data flows from brokers up through the system
• Demonstrate how the simulation system interfaces with other components
B. Integration Points:
• Broker API connections
• How different order types interact with the core system
• Where algorithms plug into the system
C. Key Interfaces:
• Common broker API interface
• Order management interfaces
• Algorithm interfaces
Implementation Details to Note
• Annotations for critical configuration points
• Version/compatibility information where relevant
Remember to maintain a balance between showing enough detail to understand the system's architecture while keeping it clean and readable. Consider creating additional detailed views for complex subsystems if necessary.