Skip to main content

​
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.9Best-effort (not in CI)
≤ 3.8Not supported
stx-python targets Python 3.11+. Support for 3.10 and below may be dropped in a future release — pin your runtime accordingly.

​
Pre-release channel

stx-python is currently in alpha. pip install stx-python may resolve to a stable version that doesn’t exist yet — prefer an explicit version during the 0.1.x series: 
pip install "stx-python==0.1.0a2"
Or opt into the pre-release channel globally: 
pip install --pre stx-python

​
Optional extras

None today.

​
Verify

python -c "import stx; print(stx.__version__)"
You should see 0.1.0a2 (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