client

Login and general Delfini operations

Functions

pydelfini.client.login(host, scheme='https')[source]

Login to a Delfini instance.

This interactive login method will print a URL that you will need to visit in order to activate the login session. The function will wait to return until the session has successfully been activated.

Parameters:

  • host (str) – The hostname of your Delfini instance, such as ‘delfini.bioteam.net’.

  • scheme (str) – either ‘https’ or ‘http’

Returns:

A DelfiniClient

Return type:

DelfiniClient

pydelfini.client.make_base_url(host, scheme='https')[source]

Create a base URL for a Delfini instance.

Parameters:

  • host (str) – The hostname of your Delfini instance, such as ‘delfini.bioteam.net’.

  • scheme (str) – either ‘https’ or ‘http’

Returns:

the Delfini API base URL

Return type:

str

Classes

DelfiniClient

Main class for interacting with a Delfini instance.