Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.sportsxapp.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Install from PyPI

pip install stx-python
The wheel is pure-Python — no compiled extensions, no platform-specific wheels.

​
Supported Python versions

PythonStatus
3.13Supported (CI)
3.12Supported (CI)
3.11Supported (CI)
3.10Best-effort (not in CI)
3.9Supported (CI)
≤ 3.8Not supported

​
Pre-release channel

stx-python is currently in alpha and lives on TestPyPI. pip install stx-python from the main PyPI index will fail until the first stable release — install from TestPyPI explicitly: 
pip install \
  --index-url https://test.pypi.org/simple/ \
  --extra-index-url https://pypi.org/simple/ \
  "stx-python>=0.5.0a1"
The --extra-index-url is required so pip can still resolve transitive dependencies (gql, aiohttp, etc.) that aren’t mirrored to TestPyPI. Once the first stable release ships to main PyPI, the install simplifies to: 
pip install stx-python

​
Optional extras

None today.

​
Verify

python -c "import stx; print(stx.__version__)"
You should see 0.5.0a1 (or newer).

​
Dependencies

The SDK pulls in the following at install time:
PackageWhy
gql[requests]>=3.4.0,<4.0GraphQL client (DSL + transport). Pinned below 4.0 — dsl_gql was removed.
aiohttp>=3.9Async HTTP transport for AsyncSTX.
websockets>=12.0Phoenix channel transport for STXWebSocket.
pydantic>=2.0Typed payload models.
No system packages required. If pip install succeeds, you’re done.

​
Editable install (contributing)

If you’re working on the SDK itself: 
git clone git@github.com:stxapp/stx-python.git
cd stx-python
pip install -e ".[test]"
pytest
See CONTRIBUTING.md for the full dev setup.

​
Uninstalling

pip uninstall stx-python
This leaves ~/.stx/ (credentials, schema cache) on disk. Delete it manually if you want a clean slate: 
rm -rf ~/.stx