Installing the Scadable SDK

The Scadable SDK is a Python package and CLI. You write device logic in Python, run scadable compile, and ship the artifacts to a gateway.

Install

pip install scadable-sdk

This installs the scadable command and the scadable Python package. Confirm it worked:

scadable version

You should see scadable-sdk 0.2.0 (or newer).

Supported Python versions

3.10, 3.11, 3.12, and 3.13. We test against all four on every commit.

Other ways to install

If you only want the CLI without polluting your global Python environment, use pipx:

pipx install scadable-sdk

If you use uv:

uv pip install scadable-sdk

Inside a project

Most teams pin the SDK in their project's dependencies so every contributor uses the same version. Add it to your requirements.txt or pyproject.toml:

scadable-sdk>=0.2.0

Upgrade

pip install --upgrade scadable-sdk

After upgrading, re-run scadable compile once. If you upgraded across a major version, see the release notes for any changes.

Troubleshooting

scadable: command not found after install. Your Python bin/ directory is not on $PATH. Add it, or run python -m scadable.cli.main instead.

pip fails on Python 3.9 or older. The SDK requires 3.10+. Install a newer Python (pyenv install 3.12.0).

Corporate proxy blocks PyPI. Configure pip to use your internal mirror: pip install --index-url https://your-mirror/simple scadable-sdk.

Next steps

• The Mental Model: how the SDK fits into the platform
• Project Layout: what scadable init creates and why
• Core Concepts: Device, Controller, Register, and the rest of the vocabulary