LOGS

A library to access the LOGS API via Python

class LOGS.LOGS.LOGS(url=None, apiKey=None, configFile=None, verbose=False, 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

create(entities)[source]
property currentUser: Person
customField(id)[source]
Return type:

CustomField

customFields(parameter=None)[source]
Return type:

CustomFields

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]
document(id)[source]
Return type:

Document

documents(parameter=None)[source]
Return type:

Documents

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

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

labNotebookEntries(parameter=None)[source]
Return type:

LabNotebookEntries

labNotebookEntry(id)[source]
Return type:

LabNotebookEntry

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

sampleType(id)[source]
Return type:

SampleType

sampleTypes(parameter=None)[source]
Return type:

SampleTypes

samples(parameter=None)[source]
Return type:

Samples

property uid: UUID | None
updatableDatasetFiles(files, formatIds)[source]
update(entities)[source]
property url: str
property version: str | None