Installation

This guide covers how to install the ProjectX Python SDK and its dependencies.

Requirements

Install the latest stable version from PyPI using uv:

uv add project-x-py

Or with pip if you prefer:

pip install project-x-py

This will install the core package with all required dependencies:

For real-time market data and WebSocket support:

uv add "project-x-py[realtime]"

Or with pip:

pip install project-x-py[realtime]

This includes:

For development and testing:

uv add "project-x-py[dev]"

Or with pip:

pip install project-x-py[dev]

This includes:

For building documentation:

uv add "project-x-py[docs]"

Or with pip:

pip install project-x-py[docs]

This includes:

To install everything:

uv add "project-x-py[all]"

Or with pip:

pip install project-x-py[all]

For development, clone the repository and install with uv:

git clone https://github.com/TexasCoding/project-x-py.git
cd project-x-py
uv sync --extra dev --extra docs

Or with pip in editable mode:

pip install -e .[dev,test,docs]

Test your installation:

python -c "import project_x_py; print(project_x_py.get_version())"

Check environment setup:

python -c "from project_x_py import check_setup; print(check_setup())"

After installation:

Import Error: No module named ‘project_x_py’

Make sure you’ve installed the package:

uv add project-x-py

Version Conflicts

If you have dependency conflicts, uv handles this automatically. For pip users, try creating a fresh virtual environment:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install project-x-py

Real-time Connection Issues

Make sure you have the real-time dependencies:

uv add "project-x-py[realtime]"