tiled.client.from_uri

tiled.client.from_uri(uri, structure_clients='numpy', *, cache=None, offline=False, username=None, auth_provider=None, api_key=None, token_cache='/home/runner/.cache/tiled/tokens', verify=True, prompt_for_reauthentication=None, headers=None, timeout=None)[source]

Connect to a Node on a local or remote server.

Parameters
uristr

e.g. “http://localhost:8000

structure_clientsstr or dict, optional

Use “dask” for delayed data loading and “numpy” for immediate in-memory structures (e.g. normal numpy arrays, pandas DataFrames). For advanced use, provide dict mapping a structure_family or a spec to a client object.

cacheCache, optional
offlinebool, optional

False by default. If True, rely on cache only.

usernamestr, optional

Username for authenticated access.

auth_providerstr, optional

Name of an authentication provider. If None and the server supports multiple provides, the user will be interactively prompted to choose from a list.

api_keystr, optional

API key based authentication. Cannot mix with username/auth_provider.

token_cachestr, optional

Path to directory for storing refresh tokens.

verifybool, optional

Verify SSL certifications. True by default. False is insecure, intended for development and testing only.

prompt_for_reauthenticationbool, optional

If True, prompt interactively for credentials if needed. If False, raise an error. By default, attempt to detect whether terminal is interactive (is a TTY).

headersdict, optional

Extra HTTP headers.

timeouthttpx.Timeout, optional

If None, use Tiled default settings. (To disable timeouts, use httpx.Timeout(None)).