You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Update docs/index.rst with v3.1.0 features and TradingSuite examples
- Modernize docs/quickstart.rst to use TradingSuite instead of factories
- Update indicator count from 55+ to 58+ (includes pattern recognition)
- Add v3.1.0 performance notes to examples/README.md
- Simplify all code examples to use unified TradingSuite interface
Key changes:
- Replace factory function examples with TradingSuite.create()
- Highlight 2-5x performance improvements in v3.1.0
- Update quick start guide for simplified initialization
- Ensure all examples reflect current best practices
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <[email protected]>
**project-x-py** is a high-performance **async Python SDK** for the `ProjectX Trading Platform <https://www.projectx.com/>`_ Gateway API. This library enables developers to build sophisticated trading strategies and applications by providing comprehensive async access to futures trading operations, real-time market data, Level 2 orderbook analysis, and a complete technical analysis suite with 55+ TA-Lib compatible indicators.
20
+
**project-x-py** is a high-performance **async Python SDK** for the `ProjectX Trading Platform <https://www.projectx.com/>`_ Gateway API. This library enables developers to build sophisticated trading strategies and applications by providing comprehensive async access to futures trading operations, real-time market data, Level 2 orderbook analysis, and a complete technical analysis suite with 58+ TA-Lib compatible indicators including pattern recognition.
21
21
22
22
.. note::
23
-
**Version 3.0.0**: Complete async architecture with EventBus integration for unified event handling. All components now use factory functions and dependency injection patterns. Enterprise-grade error handling with centralized logging and comprehensive retry mechanisms.
23
+
**Version 3.1.0**: High-performance production suite with 2-5x performance improvements. Features memory-mapped overflow storage, orjson integration, WebSocket message batching, and advanced caching with compression. Complete async architecture with unified TradingSuite interface.
24
24
25
25
.. warning::
26
26
**Development Phase**: This project is under active development. New updates may introduce breaking changes without backward compatibility. During this development phase, we prioritize clean, modern code architecture over maintaining legacy implementations.
@@ -47,37 +47,33 @@ Set up your credentials::
47
47
Start trading::
48
48
49
49
import asyncio
50
-
from project_x_py import ProjectX
50
+
from project_x_py import TradingSuite
51
51
from project_x_py.indicators import RSI, SMA, MACD
52
52
53
53
async def main():
54
-
# V3: Create client with async context manager
55
-
async with ProjectX.from_env() as client:
56
-
await client.authenticate()
57
-
58
-
# Get market data with technical analysis
59
-
data = await client.get_bars('MNQ', days=30, interval=60) # V3: actual symbol
60
-
data = RSI(data, period=14) # Add RSI
61
-
data = SMA(data, period=20) # Add moving average
62
-
data = MACD(data) # Add MACD
63
-
64
-
# V3: Place an order with JWT authentication
65
-
from project_x_py import create_order_manager, create_realtime_client
66
-
instrument = await client.get_instrument('MNQ')
67
-
68
-
# V3: Create realtime client with JWT and account ID
Copy file name to clipboardExpand all lines: examples/README.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,8 @@
1
-
# ProjectX Python SDK Examples
1
+
# ProjectX Python SDK Examples (v3.1.0)
2
2
3
-
This directory contains comprehensive working examples demonstrating all major features of the ProjectX Python SDK. All examples use **MNQ (Micro E-mini NASDAQ)** contracts to minimize risk during testing.
3
+
This directory contains comprehensive working examples demonstrating all major features of the ProjectX Python SDK v3.1.0. All examples use **MNQ (Micro E-mini NASDAQ)** contracts to minimize risk during testing.
4
+
5
+
**Note:** Version 3.1.0 includes significant performance improvements with memory-mapped overflow storage, orjson integration, and WebSocket batching for 2-5x performance gains.
0 commit comments