Install & Compatibility
Where this runs
tested against v2026.3.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
GatewayCluster
✓ from dask_gateway import GatewayCluster
✗ from dask_gateway.client import GatewayCluster
GatewayCluster is a top-level alias for the client class; direct import from .client is internal and may break.
Gateway
✓ from dask_gateway import Gateway
✗ from dask_gateway.gateway import Gateway
Gateway is available at the top-level package; importing from .gateway is an internal path.
Creates a Dask Gateway cluster, scales to 2 workers, and gets a client.
import os
from dask_gateway import GatewayCluster
# Create a cluster with token auth (or env vars)
cluster = GatewayCluster(
address=os.environ.get('DASK_GATEWAY_ADDRESS', 'http://gateway:8080'),
proxy_address=os.environ.get('DASK_GATEWAY_PROXY_ADDRESS', 'gateway:8786'),
auth='jupyterhub' if os.environ.get('JUPYTERHUB_USER') else None
)
cluster.scale(2)
client = cluster.get_client()
# Submit work
client.close()
cluster.close()
Errors
Common errors & fixes
ModuleNotFoundError: No module named 'dask_gateway'
dask-gateway not installed in the current Python environment.
fixRun `pip install dask-gateway`.
dask_gateway.exceptions.GatewayError: 401 Unauthorized - authentication failed
Invalid or missing authentication credentials.
fixPass the correct `auth` parameter (e.g., `auth='jupyterhub'`) or set `DASK_GATEWAY_AUTH` environment variable.
TypeError: __init__() got an unexpected keyword argument 'proxy_address'
In older versions (pre-2023.1.0), the `proxy_address` parameter was not available.
fixUpgrade dask-gateway: `pip install --upgrade dask-gateway`.
Upgrade
Version history
2026.3.0latest on PyPI · released Mar 31, 2026
Audit
Dependencies
daskrequiredCore dependency for distributed computing
pyyamlrequiredConfiguration parsing
tornadorequiredAsync HTTP client
kerberosoptionalKerberos authentication