Skip to content

Commit 4561c32

Browse files
committed
update readme
1 parent d0a087c commit 4561c32

3 files changed

Lines changed: 13 additions & 6 deletions

File tree

.secrets.baseline

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@
142142
"filename": "README.md",
143143
"hashed_secret": "89a6cfe2a229151e8055abee107d45ed087bbb4f",
144144
"is_verified": false,
145-
"line_number": 424
145+
"line_number": 431
146146
}
147147
],
148148
"docs/authentication.rst": [
@@ -325,5 +325,5 @@
325325
}
326326
]
327327
},
328-
"generated_at": "2025-09-01T00:25:00Z"
328+
"generated_at": "2025-09-01T01:31:44Z"
329329
}

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11
# ProjectX Python SDK
22

3+
[![CI](https://github.com/TexasCoding/project-x-py/workflows/CI/badge.svg)](https://github.com/TexasCoding/project-x-py/actions/workflows/ci.yml)
4+
[![codecov](https://codecov.io/gh/TexasCoding/project-x-py/branch/main/graph/badge.svg)](https://codecov.io/gh/TexasCoding/project-x-py)
5+
[![PyPI - Version](https://img.shields.io/pypi/v/project-x-py)](https://pypi.org/project/project-x-py/)
6+
[![PyPI - Downloads](https://img.shields.io/pypi/dm/project-x-py)](https://pypi.org/project/project-x-py/)
37
[![Python Version](https://img.shields.io/badge/python-3.12%2B-blue.svg)](https://python.org)
48
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
5-
[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
9+
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
10+
[![MyPy](https://img.shields.io/badge/mypy-checked-blue)](https://github.com/python/mypy)
11+
[![Security: bandit](https://img.shields.io/badge/security-bandit-green.svg)](https://github.com/PyCQA/bandit)
612
[![Performance](https://img.shields.io/badge/performance-optimized-brightgreen.svg)](#performance-optimizations)
713
[![Async](https://img.shields.io/badge/async-native-brightgreen.svg)](#async-architecture)
14+
[![Documentation](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://texascoding.github.io/project-x-py/)
815

916
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, historical market data, real-time streaming, technical analysis, and advanced market microstructure tools with enterprise-grade performance optimizations.
1017

@@ -826,8 +833,8 @@ This project is licensed under the MIT License - see [LICENSE](LICENSE) file for
826833
## 🔗 Resources
827834

828835
- [ProjectX Platform](https://www.projectx.com/)
829-
- [API Documentation](https://documenter.getpostman.com/view/24500417/2s9YRCXrKF)
830-
- [GitHub Repository](https://github.com/yourusername/project-x-py)
836+
- [API Documentation](https://texascoding.github.io/project-x-py/)
837+
- [GitHub Repository](https://github.com/TexasCoding/project-x-py)
831838
- [PyPI Package](https://pypi.org/project/project-x-py/)
832839

833840
## ⚠️ Disclaimer

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![PyPI version](https://img.shields.io/pypi/v/project-x-py.svg)](https://pypi.org/project/project-x-py/)
44
[![Python versions](https://img.shields.io/pypi/pyversions/project-x-py.svg)](https://pypi.org/project/project-x-py/)
55
[![License](https://img.shields.io/github/license/TexasCoding/project-x-py.svg)](https://github.com/TexasCoding/project-x-py/blob/main/LICENSE)
6-
[![Documentation Status](https://readthedocs.org/projects/project-x-py/badge/?version=latest)](https://project-x-py.readthedocs.io/en/latest/?badge=latest)
6+
[![Documentation](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://texascoding.github.io/project-x-py/)
77

88
**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 59+ TA-Lib compatible indicators including pattern recognition and chaos theory analysis.
99

0 commit comments

Comments
 (0)