GFClient API

gfslib.client.GFClient

Connect using a server root URL, e.g. https://host/.

Returned discovery records retain the server's JSON fields, including dataset attributes and datasource details. HTTP and decoding errors raise.

base_url = base_url.rstrip('/') instance-attribute

timeout = timeout instance-attribute

__init__(base_url, timeout=30.0)

datasets(workspace_id)

List workspace datasets, including the attributes exposed by GF.

datasources(workspace_id)

List workspace datasource descriptions and properties.

set_api_key(key)

Set the key for discovery and subsequently created storage clients.

storage(workspace_id)

Create a storage client using the current key and timeout.

Subsequent key changes on this GFClient do not change existing clients.

workspace(workspace_id)

Get a workspace's name, description and available services.

workspaces()

List the workspaces returned by the server for the current credentials.