Skip to content

Commit 190ea3a

Browse files
committed
docs: Add release notes for v3.1.9
- Update README.md version to v3.1.9 - Add CHANGELOG.md entry for tick price alignment fixes - Update CLAUDE.md with recent changes - Document ProjectX volume data limitations
1 parent 3b3540a commit 190ea3a

File tree

7 files changed

+33
-10
lines changed

7 files changed

+33
-10
lines changed

CHANGELOG.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1414
- Migration guides will be provided for all breaking changes
1515
- Semantic versioning (MAJOR.MINOR.PATCH) is strictly followed
1616

17+
## [3.1.9] - 2025-08-12
18+
19+
### Fixed
20+
- **💹 Tick Price Alignment**: All prices now properly aligned to instrument tick size
21+
- Bar OHLC prices aligned during creation and updates (e.g., NQ prices snap to 0.25 increments)
22+
- Current price from `get_current_price()` now returns tick-aligned values
23+
- Empty bars created during low-volume periods use aligned prices
24+
- Prevents invalid prices like $23,927.62 for NQ (now correctly $23,927.50 or $23,927.75)
25+
26+
### Documentation
27+
- **📊 Volume Data Clarification**: Documented that ProjectX provides platform-specific volume
28+
- Volume data represents trades executed through ProjectX platform only
29+
- Not full exchange volume from CME
30+
- This is a data feed limitation, not a bug in the SDK
31+
- Prices remain accurate despite lower volume numbers
32+
1733
## [3.1.8] - 2025-08-12
1834

1935
### Fixed

CLAUDE.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
44

5-
## Project Status: v3.1.8 - Stable Production Release
5+
## Project Status: v3.1.9 - Stable Production Release
66

77
**IMPORTANT**: This project uses a fully asynchronous architecture. All APIs are async-only, optimized for high-performance futures trading.
88

@@ -288,13 +288,20 @@ async with ProjectX.from_env() as client:
288288

289289
## Recent Changes
290290

291-
### v3.1.8 - Latest Release
291+
### v3.1.9 - Latest Release
292+
- **Fixed**: Tick price alignment in real-time data manager
293+
- All OHLC prices now properly aligned to instrument tick size
294+
- `get_current_price()` returns tick-aligned values
295+
- Prevents invalid prices (e.g., $23,927.62 for NQ now snaps to $23,927.50)
296+
- **Documented**: ProjectX volume data limitation (platform-specific, not full exchange volume)
297+
298+
### v3.1.8 - Previous Release
292299
- **Fixed**: Real-time data processing for E-mini contracts (NQ/ES) that resolve to different symbols
293300
- **Added**: Bar timer mechanism to create empty bars during low-volume periods
294301
- **Improved**: Symbol matching to handle contract resolution (e.g., NQ→ENQ)
295302
- **Enhanced**: Real-time data manager now properly processes all futures contracts
296303

297-
### v3.1.7 - Previous Release
304+
### v3.1.7
298305
- Minor updates and improvements
299306
- Documentation enhancements
300307

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ A **high-performance async Python SDK** for the [ProjectX Trading Platform](http
2121

2222
This Python SDK acts as a bridge between your trading strategies and the ProjectX platform, handling all the complex API interactions, data processing, and real-time connectivity.
2323

24-
## 🚀 v3.1.6 - Stable Production Release
24+
## 🚀 v3.1.9 - Stable Production Release
2525

26-
**Latest Version**: v3.1.6 - Fixed critical deadlock in event handlers. See [CHANGELOG.md](CHANGELOG.md) for full release history.
26+
**Latest Version**: v3.1.9 - Fixed tick price alignment in real-time data. See [CHANGELOG.md](CHANGELOG.md) for full release history.
2727

2828
### 📦 Production Stability Guarantee
2929

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@
2323
project = "project-x-py"
2424
copyright = "2025, Jeff West"
2525
author = "Jeff West"
26-
release = "3.1.8"
27-
version = "3.1.8"
26+
release = "3.1.9"
27+
version = "3.1.9"
2828

2929
# -- General configuration ---------------------------------------------------
3030

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "project-x-py"
3-
version = "3.1.8"
3+
version = "3.1.9"
44
description = "High-performance Python SDK for futures trading with real-time WebSocket data, technical indicators, order management, and market depth analysis"
55
readme = "README.md"
66
license = { text = "MIT" }

src/project_x_py/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@
9595

9696
from project_x_py.client.base import ProjectXBase
9797

98-
__version__ = "3.1.8"
98+
__version__ = "3.1.9"
9999
__author__ = "TexasCoding"
100100

101101
# Core client classes - renamed from Async* to standard names

src/project_x_py/indicators/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@
202202
)
203203

204204
# Version info
205-
__version__ = "3.1.8"
205+
__version__ = "3.1.9"
206206
__author__ = "TexasCoding"
207207

208208

0 commit comments

Comments
 (0)