LOGS

A library to access the LOGS API via Python

class LOGS.LOGS.LOGS(url=None, apiKey=None, configFile=None, options=None, verify=True)[source]

Bases: object

Python class to access the LOGS web API

property apiUrl: str

bridge(id)[source]

Return type:: Bridge

bridges(parameter=None)[source]

Return type:: Bridges

property cacheDir: str | None

create(entities)[source]

property currentUser: Person

customField(id)[source]

Return type:: CustomField

customFields(parameter=None)[source]

Return type:: CustomFields

customType(id)[source]

Return type:: CustomType

customTypes(parameter=None)[source]

Return type:: CustomTypes

dataSource(id)[source]

Return type:: DataSource

dataSources(parameter=None)[source]

Return type:: DataSources

dataset(id)[source]

Return type:: Dataset

datasetMatching(files, formatIds=None, ignoreReadErrors=False)[source]

Return type:: DatasetMatching

datasets(parameter=None)[source]

Return type:: Datasets

delete(entities=None, permanently=False)[source]

deleteById(entityType=None, ids=None, permanently=False)[source]

entities(parameter=None)[source]

Return type:: Entities

entity(uid)[source]

experiment(id)[source]

Return type:: Experiment

experiments(parameter=None)[source]

Return type:: Experiments

format(id)[source]

Return type:: Format

formatFormat(id)[source]

Return type:: FormatFormat

formatFormats(parameter=None)[source]

Return type:: FormatFormats

formatInstrument(id)[source]

Return type:: FormatInstrument

formatInstruments(parameter=None)[source]

Return type:: FormatInstruments

formatMethod(id)[source]

Return type:: FormatMethod

formatMethods(parameter=None)[source]

Return type:: FormatMethods

formatVendor(id)[source]

Return type:: FormatVendor

formatVendors(parameter=None)[source]

Return type:: FormatVendors

formats(parameter=None)[source]

Return type:: Formats

getDatasetDir(dataset)[source]

classmethod getHumanReadableSize(size, suffix='B')[source]

property group: str | None

property instanceOrigin: Origin

instrument(id)[source]

Return type:: Instrument

instruments(parameter=None)[source]

Return type:: Instruments

inventories(parameter=None)[source]

Return type:: Inventories

inventory(id)[source]

Return type:: Inventory

labNotebook(id)[source]

Return type:: LabNotebook

labNotebookEntries(parameter=None)[source]

Return type:: LabNotebookEntries

labNotebookEntry(id)[source]

Return type:: LabNotebookEntry

labNotebookExperiment(id)[source]

Return type:: LabNotebookExperiment

labNotebookExperiments(parameter=None)[source]

Return type:: LabNotebookExperiments

labNotebooks(parameter=None)[source]

Return type:: LabNotebooks

property metadata: ServerMetaData

method(id)[source]

Return type:: Method

methods(parameter=None)[source]

Return type:: Methods

origin(id)[source]

Return type:: Origin

origins(parameter=None)[source]

Return type:: Origins

person(id)[source]

Return type:: Person

persons(parameter=None)[source]

Return type:: Persons

printServerStatus()[source]

project(id)[source]

Return type:: Project

projects(parameter=None)[source]

Return type:: Projects

restore(entities)[source]

role(id)[source]

Return type:: Role

roles(parameter=None)[source]

Return type:: Roles

sample(id)[source]

Return type:: Sample

samples(parameter=None)[source]

Return type:: Samples

property uid: UUID | None

updatableDatasetFiles(files, formatIds)[source]

update(entities)[source]

property url: str

version()[source]

Return type:: Optional[str]