Install

The SDK package name is surfra. It needs Python 3.11 or newer.

1. Install the package from a checkout of the SDK until it is published on PyPI.

   pip install -e ./surfra-python-sdk

   Note

   pip install surfra will work after the package is published. It is not on PyPI yet.

2. Create an API key in the dashboard under Credentials. The secret is shown when you click View.

3. Point the client at your control plane.

   export SURFRA_API_KEY=sfk_...
   export SURFRA_MASTER=https://api.surfra.io

SURFRA_API_KEY is the key the client sends. SURFRA_MASTER is the control plane URL. Both are read by surfra.SurfraClient and by surfra.App.