sampledbapi.comm module

class sampledbapi.comm.SampleDBObject(d: Dict)[source]

Bases: object

sampledbapi.comm.__headers() → Dict[source]
sampledbapi.comm.authenticate(address: str, api_key: str)[source]

Authenticate with a SampleDB instance

To retrieve data from SampleDB and upload data to it, you have to authenticate first.

Parameters:

  • address – URL of the SampleDB server.

  • api_key – API token you can generate using “Preferences/API Tokens”.

sampledbapi.comm.get_data(path: str, params: Dict[str, Any] | None = None) → Any[source]
sampledbapi.comm.post_data(path: str, data) → Response[source]
sampledbapi.comm.put_data(path: str, data) → Response[source]