Skip to content

Installation

Requirements

  • Python: 3.10–3.13 (CPython)
  • Network: Outbound HTTPS (and WSS) to Werk24 API

Python 3.9 end of support

Python 3.9 is no longer supported.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# 1) Ensure a recent pip
python -m pip install --upgrade pip

# 2) Install Werk24
python -m pip install werk24

# 3) Initialize (creates config and obtains a trial license)
werk24 init

# 4) Verify your setup
werk24 health-check

If the health check prints positive messages, you’re good to go.

Important

The Health Check verifies a secure WebSocket (WSS) connection to Werk24. Corporate firewalls often block WSS. If it fails:

  • Allow outbound WSS (TLS) on port 443
  • Whitelist wss://ws-api.w24.co (or your regional endpoint)

Upgrading

1
2
python -m pip install --upgrade werk24
werk24 health-check

Troubleshooting

  • Multiple Pythons installed: Run python --version and python -m pip --version to confirm you’re using Python 3.10–3.13 and the matching pip.
  • Proxy/Firewall: If initialization fails, check outbound HTTPS and any corporate proxy settings.
  • Permission errors: Use a virtual environment or add --user to the pip command.

Next steps

  • CLI requests: Learn to send drawings from the terminal → CLI guide
  • API usage: Use the Python client in your app → API requests