DelfiniClient

class pydelfini.client.DelfiniClient(core)

Bases: object

Main class for interacting with a Delfini instance.

Parameters:

core (AuthenticatedClient)

all_collections()

Iterate over all collections visible to the user.

Return type:

Iterator[DelfiniCollection]

get_collection_by_name(collection_name)

Retrieve a single collection given its name.

Raises:

ValueError – if the collection could not be found or if more than one collection was found with the given name

Parameters:

collection_name (str)

Return type:

DelfiniCollection

new_collection(name, description, metadata={})

Create a new collection.

Parameters:

• name (str) – The short name of the collection

• description (str) – A longer plain text description of the collection

• metadata (dict[str, str]) – Optional key-value pairs of metadata on the collection

Return type:

DelfiniCollection