labstep 3.28.2__tar.gz → 3.30.0__tar.gz

{labstep-3.28.2 → labstep-3.30.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: labstep
-Version: 3.28.2
+Version: 3.30.0
 Summary: Python SDK for working with the Labstep API
 Home-page: http://github.com/Labstep/labstepPy
 Author: Labstep

labstep-3.30.0/labstep/constants/version.py

@@ -0,0 +1 @@
+VERSION = "3.30.0"

{labstep-3.28.2 → labstep-3.30.0}/labstep/entities/collaborator/repository.py

@@ -19,13 +19,8 @@ def assign(parent_entity, user_id, extraParams):
 
 
 def unassign(collaborator, extraParams={}):
-    entity_name = collaborator['permission_entity_info']['entityName']
-    params = {f'{entity_name}_id': collaborator['permission_entity_info']['id'],
-              'user_id': collaborator['user']['id'],
-              'is_assigned': False,
-              **extraParams}
+    return editEntity(collaborator,{'is_assigned': False})
 
-    return newEntity(collaborator.__user__, Collaborator, params)
 
 
 def getCollaborators(parent_entity, count, extraParams):

{labstep-3.28.2 → labstep-3.30.0}/labstep/entities/experiment/repository.py

@@ -2,15 +2,13 @@
 # -*- coding: utf-8 -*-
 # Author: Labstep <dev@labstep.com>
 
-from labstep.service.helpers import (
-    handleDate,
-)
-from labstep.entities.experiment.model import Experiment, ExperimentProtocol
 import labstep.generic.entity.repository as entityRepository
+from labstep.config.export import includePDF
+from labstep.constants import UNSPECIFIED
+from labstep.entities.experiment.model import Experiment, ExperimentProtocol
+from labstep.service.helpers import handleDate
 from labstep.service.htmlExport import htmlExportService
 from labstep.service.htmlToPDF import htmlToPDF
-from labstep.constants import UNSPECIFIED
-from labstep.config.export import includePDF
 
 
 def getExperiment(user, experiment_id):

{labstep-3.28.2 → labstep-3.30.0}/labstep/entities/experimentTemplate/repository.py

@@ -2,15 +2,14 @@
 # -*- coding: utf-8 -*-
 # Author: Labstep <dev@labstep.com>
 
-from labstep.service.helpers import (
-    handleDate,
-)
-from labstep.entities.experimentTemplate.model import ExperimentTemplate, ExperimentProtocol
 import labstep.generic.entity.repository as entityRepository
+from labstep.config.export import includePDF
+from labstep.constants import UNSPECIFIED
+from labstep.entities.experimentTemplate.model import (ExperimentProtocol,
+                                                       ExperimentTemplate)
+from labstep.service.helpers import handleDate
 from labstep.service.htmlExport import htmlExportService
 from labstep.service.htmlToPDF import htmlToPDF
-from labstep.constants import UNSPECIFIED
-from labstep.config.export import includePDF
 
 
 def getExperimentTemplate(user, experiment_template_id):

{labstep-3.28.2 → labstep-3.30.0}/labstep/entities/jupyterInstance/model.py

@@ -14,7 +14,7 @@ class JupyterInstance(Entity):
     __entityName__ = "jupyter-instance"
     __hasGuid__ = True
 
-    def edit(self, startedAt=UNSPECIFIED, endedAt=UNSPECIFIED, status=UNSPECIFIED, errorMessage=UNSPECIFIED):
+    def edit(self, startedAt=UNSPECIFIED, endedAt=UNSPECIFIED, status=UNSPECIFIED, data=UNSPECIFIED, errorMessage=UNSPECIFIED):
         """
         Edit an existing JupyterInstance.
 
@@ -48,5 +48,6 @@ class JupyterInstance(Entity):
             startedAt,
             endedAt,
             status,
+            data,
             errorMessage
         )

{labstep-3.28.2 → labstep-3.30.0}/labstep/entities/jupyterInstance/repository.py

@@ -16,12 +16,14 @@ def editJupyterInstance(
     startedAt=UNSPECIFIED,
     endedAt=UNSPECIFIED,
     status=UNSPECIFIED,
+    data=UNSPECIFIED,
     errorMessage=UNSPECIFIED
 ):
     params = {
         "started_at": startedAt,
         "ended_at": endedAt,
         "status": status,
+        "data": data,
         "error_message": errorMessage,
     }
 

{labstep-3.28.2 → labstep-3.30.0}/labstep/entities/protocol/model.py

@@ -2,11 +2,11 @@
 # -*- coding: utf-8 -*-
 # Author: Labstep <dev@labstep.com>
 from deprecated import deprecated
+from labstep.constants import UNSPECIFIED
+from labstep.entities.protocolVersion.model import ProtocolVersion
 from labstep.generic.entity.repository import getEntityProperty
 from labstep.generic.entityPrimary.model import EntityPrimary
-from labstep.entities.protocolVersion.model import ProtocolVersion
 from labstep.service.helpers import getTime
-from labstep.constants import UNSPECIFIED
 
 
 class Protocol(EntityPrimary):
@@ -26,10 +26,27 @@ class Protocol(EntityPrimary):
     __entityName__ = "protocol-collection"
     __searchKey__ = 'label'
 
+    @property
+    def draft_version(self):
+        return getEntityProperty(self, 'draft_version', ProtocolVersion)
+
     @property
     def last_version(self):
         return getEntityProperty(self, 'last_version', ProtocolVersion)
 
+    def getCurrentVersion(self):
+        """
+        Returns the current version of the protocol.
+
+        Returns
+        -------
+        :class:`~labstep.entities.protocolVersion.model.ProtocolVersion`
+            The current version of the protocol.
+        """
+        if self.draft_version:
+            return self.draft_version
+        return self.last_version
+
     def edit(self, name=UNSPECIFIED, body=UNSPECIFIED, extraParams={}):
         """
         Edit an existing Protocol.
@@ -124,7 +141,7 @@ class Protocol(EntityPrimary):
 
             my_protocol.getBody()
         """
-        return self.last_version.getBody()
+        return self.getCurrentVersion().getBody()
 
     def addSteps(self, N):
         """
@@ -142,7 +159,7 @@ class Protocol(EntityPrimary):
             my_protocol = user.newProtocol('My API Protocol')
             my_protocol.addSteps(5)
         """
-        return self.last_version.addSteps(N)
+        return self.getCurrentVersion().addSteps(N)
 
     def getSteps(self):
         """
@@ -161,7 +178,7 @@ class Protocol(EntityPrimary):
             protocol_steps = protocol.getSteps()
             protocol_steps[0].attributes()
         """
-        return self.last_version.getSteps()
+        return self.getCurrentVersion().getSteps()
 
     def getDataFields(self):
         """
@@ -180,7 +197,7 @@ class Protocol(EntityPrimary):
             protocol = user.getProtocol(17000)
             metadata = protocol.getDataFields()
         """
-        return self.last_version.getDataFields()
+        return self.getCurrentVersion().getDataFields()
 
     def addDataField(
         self,
@@ -226,7 +243,7 @@ class Protocol(EntityPrimary):
             dataField = protocol.addDataField("Refractive Index",
                                                value="1.73")
         """
-        return self.last_version.addDataField(
+        return self.getCurrentVersion().addDataField(
             fieldName=fieldName,
             fieldType=fieldType,
             value=value,
@@ -269,7 +286,7 @@ class Protocol(EntityPrimary):
             protocol.addInventoryField(name='Sample A', amount='2', units='ml',
                                  resource_id=resource.id)
         """
-        return self.last_version.addInventoryField(
+        return self.getCurrentVersion().addInventoryField(
             resource_id=resource_id, name=name,
             amount=amount,
             units=units,
@@ -292,7 +309,7 @@ class Protocol(EntityPrimary):
             protocol_inventoryFields = protocol.getInventoryFields()
             protocol_inventory_fields[0]
         """
-        return self.last_version.getInventoryFields(count=count, extraParams=extraParams)
+        return self.getCurrentVersion().getInventoryFields(count=count, extraParams=extraParams)
 
     def addTimer(self, name=UNSPECIFIED, hours=UNSPECIFIED, minutes=UNSPECIFIED, seconds=UNSPECIFIED):
         """
@@ -321,7 +338,7 @@ class Protocol(EntityPrimary):
             protocol = user.getProtocol(17000)
             protocol.addTimer(name='Refluxing', hours='4', minutes='30')
         """
-        return self.last_version.addTimer(name=name, hours=hours, minutes=minutes, seconds=seconds)
+        return self.getCurrentVersion().addTimer(name=name, hours=hours, minutes=minutes, seconds=seconds)
 
     def getTimers(self):
         """
@@ -340,7 +357,7 @@ class Protocol(EntityPrimary):
             protocol_timers = protocol.getTimers()
             protocol_timers[0].attributes()
         """
-        return self.last_version.getTimers()
+        return self.getCurrentVersion().getTimers()
 
     def addTable(self, name=UNSPECIFIED, data=UNSPECIFIED):
         """
@@ -383,7 +400,7 @@ class Protocol(EntityPrimary):
             protocol = user.getProtocol(17000)
             protocol.addTable(name='Calibration', data=data)
         """
-        return self.last_version.addTable(name=name, data=data)
+        return self.getCurrentVersion().addTable(name=name, data=data)
 
     def getTables(self):
         """
@@ -402,7 +419,7 @@ class Protocol(EntityPrimary):
             protocol_tables = protocol.getTables()
             protocol_tables[0].attributes()
         """
-        return self.last_version.getTables()
+        return self.getCurrentVersion().getTables()
 
     def addToCollection(self, collection_id):
         """
@@ -464,7 +481,7 @@ class Protocol(EntityPrimary):
             protocol = user.getProtocol(17000)
             protocol.addFile(filepath='./my_file.csv')
         """
-        return self.last_version.addFile(filepath=filepath, rawData=rawData)
+        return self.getCurrentVersion().addFile(filepath=filepath, rawData=rawData)
 
     def getFiles(self):
         """
@@ -482,7 +499,7 @@ class Protocol(EntityPrimary):
             protocol = user.getProtocol(17000)
             protocol_files = protocol.getFiles()
         """
-        return self.last_version.getFiles()
+        return self.getCurrentVersion().getFiles()
 
     def export(self, path):
         """
@@ -521,7 +538,7 @@ class Protocol(EntityPrimary):
             jupyter_notebooks = protocol.getJupyterNotebooks()
             print(jupyter_notebooks[0])
         """
-        return self.last_version.getJupyterNotebooks()
+        return self.getCurrentVersion().getJupyterNotebooks()
 
     def addJupyterNotebook(self, name=UNSPECIFIED, data=UNSPECIFIED):
         """
@@ -546,7 +563,7 @@ class Protocol(EntityPrimary):
             protocol = user.getProtocol(17000)
             protocol.addJupyterNotebook()
         """
-        return self.last_version.addJupyterNotebook(name=name, data=data)
+        return self.getCurrentVersion().addJupyterNotebook(name=name, data=data)
 
     def addConditions(self, number_of_conditions):
         """
@@ -567,7 +584,7 @@ class Protocol(EntityPrimary):
             conditions = protocol.addConditions(5)
         """
 
-        return self.last_version.addConditions(number_of_conditions)
+        return self.getCurrentVersion().addConditions(number_of_conditions)
 
     def getConditions(self):
         """
@@ -584,7 +601,7 @@ class Protocol(EntityPrimary):
             conditions = protocol.getConditions()
         """
 
-        return self.last_version.getConditions()
+        return self.getCurrentVersion().getConditions()
 
     @deprecated(version='3.3.2', reason="You should use experiment.addDataField instead")
     def addDataElement(self, *args, **kwargs):

{labstep-3.28.2 → labstep-3.30.0}/labstep/entities/protocol/repository.py

@@ -2,15 +2,13 @@
 # -*- coding: utf-8 -*-
 # Author: Labstep <dev@labstep.com>
 
-from labstep.service.helpers import (
-    handleDate,
-)
+import labstep.generic.entity.repository as entityRepository
+from labstep.config.export import includePDF
+from labstep.constants import UNSPECIFIED
 from labstep.entities.protocol.model import Protocol
 from labstep.entities.protocolVersion.model import ProtocolVersion
-import labstep.generic.entity.repository as entityRepository
+from labstep.service.helpers import handleDate
 from labstep.service.htmlExport import htmlExportService
-from labstep.constants import UNSPECIFIED
-from labstep.config.export import includePDF
 from labstep.service.htmlToPDF import htmlToPDF
 
 
@@ -51,7 +49,7 @@ def editProtocol(
     params = {"name": name, "deleted_at": deleted_at, **extraParams}
 
     if body is not UNSPECIFIED:
-        entityRepository.editEntity(protocol.last_version, {"state": body})
+        entityRepository.editEntity(protocol.getCurrentVersion(), {"state": body})
         protocol.update()
 
     return entityRepository.editEntity(protocol, params)

{labstep-3.28.2 → labstep-3.30.0}/labstep/entities/protocolVersion/model.py

@@ -2,18 +2,19 @@
 # -*- coding: utf-8 -*-
 # Author: Labstep <dev@labstep.com>
 
-from labstep.generic.entityWithComments.model import EntityWithComments
+import labstep.entities.file.repository as fileRepository
+import labstep.entities.protocolInventoryField.repository as protocolInventoryFieldRepository
+from labstep.constants import UNSPECIFIED
+from labstep.entities.file.model import File
 from labstep.entities.jupyterNotebook.model import JupyterNotebook
 from labstep.entities.protocolDataField.model import ProtocolDataField
+from labstep.entities.protocolInventoryField.model import \
+    ProtocolInventoryField
 from labstep.entities.protocolStep.model import ProtocolStep
 from labstep.entities.protocolTable.model import ProtocolTable
 from labstep.entities.protocolTimer.model import ProtocolTimer
-from labstep.entities.protocolInventoryField.model import ProtocolInventoryField
-import labstep.entities.protocolInventoryField.repository as protocolInventoryFieldRepository
 from labstep.generic.entityList.model import EntityList
-from labstep.entities.file.model import File
-import labstep.entities.file.repository as fileRepository
-from labstep.constants import UNSPECIFIED
+from labstep.generic.entityWithComments.model import EntityWithComments
 
 
 class ProtocolVersion(EntityWithComments):
@@ -52,6 +53,21 @@ class ProtocolVersion(EntityWithComments):
             self, body=body, extraParams=extraParams
         )
 
+    def setLive(self):
+        """
+        Set the protocol version as the live version.
+
+        Example
+        -------
+        ::
+
+            my_protocol = user.getProtocol(17000)
+            my_protocol.setLive()
+        """
+        import labstep.entities.protocolVersion.repository as protocolVersionRepository
+
+        return protocolVersionRepository.edit(self, is_draft=False)
+
     def getProtocol(self):
         """
         Returns the parent protocol
@@ -550,11 +566,12 @@ class ProtocolVersion(EntityWithComments):
         Example
         -------
         ::
-        
+
             protocol = user.getProtocol(17000)
             conditions = protocol.addConditions(5)
         """
-        from labstep.entities.protocolCondition.repository import addProtocolConditions
+        from labstep.entities.protocolCondition.repository import \
+            addProtocolConditions
 
         return addProtocolConditions(self, number_of_conditions)
 
@@ -572,6 +589,7 @@ class ProtocolVersion(EntityWithComments):
             protocol = user.getProtocol(17000)
             conditions = protocol.getConditions()
         """
-        from labstep.entities.protocolCondition.repository import getProtocolConditions
+        from labstep.entities.protocolCondition.repository import \
+            getProtocolConditions
 
         return getProtocolConditions(self)

{labstep-3.28.2 → labstep-3.30.0}/labstep/entities/protocolVersion/repository.py

@@ -1,10 +1,18 @@
 import labstep.generic.entity.repository as entityRepository
-from labstep.service.htmlExport import htmlExportService
-from labstep.constants import UNSPECIFIED
 from labstep.config.export import includePDF
+from labstep.constants import UNSPECIFIED
+from labstep.service.htmlExport import htmlExportService
 from labstep.service.htmlToPDF import htmlToPDF
 
 
+def edit(
+    protocolVersion, is_draft=UNSPECIFIED, extraParams={}
+):
+    params = {"is_draft": is_draft, **extraParams}
+
+    return entityRepository.editEntity(protocolVersion, params)
+
+
 def exportProtocolVersion(protocolVersion, root_path):
 
     protocolVersion.update()

{labstep-3.28.2 → labstep-3.30.0}/labstep/entities/user/model.py

@@ -50,9 +50,9 @@ class User(Entity):
         from labstep.service.config import configService
         from labstep.service.request import requestService
 
-        apikey = self.__user__['api_key']
+        headers = getHeaders(self)
         url = url_join(configService.getHost(), "api/generic/user/info")
-        response = requestService.get(url, headers={"apikey": apikey})
+        response = requestService.get(url, headers=headers)
         data = json.loads(response.content)
         update(self, data)
         return self

{labstep-3.28.2 → labstep-3.30.0}/labstep.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: labstep
-Version: 3.28.2
+Version: 3.30.0
 Summary: Python SDK for working with the Labstep API
 Home-page: http://github.com/Labstep/labstepPy
 Author: Labstep

labstep-3.28.2/labstep/constants/version.py

@@ -1 +0,0 @@
-VERSION = "3.28.2"