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

attachment(id)[source]

Return type:: Attachment

attachments(parameter=None)[source]

Return type:: Attachments

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

dataFormat(id)[source]

Return type:: DataFormat

dataFormatInstrument(id)[source]

Return type:: DataFormatInstrument

dataFormatInstruments(parameter=None)[source]

Return type:: DataFormatInstruments

dataFormats(parameter=None)[source]

Return type:: DataFormats

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]

getDatasetDir(dataset)[source]

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

getTypedEntityClass(customTypeOrId, entityType)[source]

Return type:: Type[TypeVar(_T, bound= Union[Bridge, CustomField, CustomType, Dataset, DataSource, InventoryItem, LabNotebook, LabNotebookEntry, LabNotebookExperiment, LabNotebookTemplate, Origin, Person, Project, Sample, DataFormat, Role, Vendor, DataFormatInstrument, Method, Attachment, Entity])]

property group: str | None

property instanceOrigin: Origin

inventoryItem(id)[source]

Return type:: InventoryItem

inventoryItems(parameter=None)[source]

Return type:: InventoryItems

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

labNotebookTemplate(id)[source]

Return type:: LabNotebookTemplate

labNotebookTemplates(parameter=None)[source]

Return type:: LabNotebookTemplates

labNotebooks(parameter=None)[source]

Return type:: LabNotebooks

property metadata: ServerMetaData

method(id)[source]

Return type:: Method

methods(parameter=None)[source]

Return type:: Methods

newAttachment(ref=None, files=None, pathPrefixToStrip=None, pathPrefixToAdd=None)[source]

Return type:: Attachment

newBridge(ref=None)[source]

Return type:: Bridge

newCustomField(ref=None)[source]

Return type:: CustomField

newCustomType(ref=None)[source]

Return type:: CustomType

newDataFormat(ref=None)[source]

Return type:: DataFormat

newDataFormatInstrument(ref=None)[source]

Return type:: DataFormatInstrument

newDataSource(ref=None)[source]

Return type:: DataSource

newDataset(entityOrCustomTypeOrId=None, ref=None, files=None, formatOrFormatId=None, pathPrefixToStrip=None, pathPrefixToAdd=None)[source]

Return type:: Dataset

newInventoryItem(customTypeOrId=None, ref=None)[source]

Return type:: InventoryItem

newLabNotebook(ref=None)[source]

Return type:: LabNotebook

newLabNotebookEntry(ref=None)[source]

Return type:: LabNotebookEntry

newLabNotebookExperiment(ref=None)[source]

Return type:: LabNotebookExperiment

newLabNotebookTemplate(ref=None)[source]

Return type:: LabNotebookTemplate

newMethod(ref=None)[source]

Return type:: Method

newOrigin(ref=None, name=None, url=None, uid=None)[source]

Return type:: Origin

newPerson(entityOrCustomTypeOrId=None, ref=None)[source]

Return type:: Person

newProject(entityOrCustomTypeOrId=None, ref=None, name='')[source]

Return type:: Project

newRole(ref=None)[source]

Return type:: Role

newSample(entityOrCustomTypeOrId=None, ref=None, name='', projects=None)[source]

Return type:: Sample

newSharedContent(ref=None)[source]

Return type:: SharedContent

newVendor(ref=None)[source]

Return type:: Vendor

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

sharedContent(id)[source]

Return type:: SharedContent

sharedContents(parameter=None)[source]

Return type:: SharedContents

property uid: UUID | None

updatableDatasetFiles(files, formatIds)[source]

update(entities)[source]

property url: str

vendor(id)[source]

Return type:: Vendor

vendors(parameter=None)[source]

Return type:: Vendors

version()[source]

Return type:: Optional[str]

class LOGS.LOGS.test[source]: Bases: object