labstep 3.26.0__tar.gz → 3.27.0__tar.gz

{labstep-3.26.0 → labstep-3.27.0}/PKG-INFO

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

labstep-3.27.0/labstep/constants/version.py

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

labstep-3.27.0/labstep/entities/jupyterInstance/model.py

@@ -0,0 +1,51 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Author: Labstep <dev@labstep.com>
+
+from labstep.generic.entity.model import Entity
+
+
+class JupyterInstance(Entity):
+    """
+    Represents an JupyterInstance on Labstep.
+    """
+
+    __entityName__ = "jupyter-instance"
+    __hasGuid__ = True
+
+    def edit(self, startedAt=UNSPECIFIED, endedAt=UNSPECIFIED, status=UNSPECIFIED, errorMessage=UNSPECIFIED):
+        """
+        Edit an existing JupyterInstance.
+
+        Parameters
+        ----------
+        startedAt (datetime, optional)
+            Start date.
+        endedAt (datetime, optional)
+            End date.
+        status (string, optional)
+            Status can be 'success' or 'error'.
+        errorMessage (string, optional)
+            Error message.
+
+        Returns
+        -------
+        :class:`~labstep.entities.jupyterInstance.model.Device`
+            An object representing the edited Device.
+
+        Example
+        -------
+        ::
+
+            myJuyterInstance = user.getJupyterInstance('943fe3f3-a50e-40a0-9b91-a0fa5675b9ac)
+            myJuyterInstance.edit(startedAt='2024-01-01T00:00:00+0000')
+        """
+        import labstep.entities.jupyterInstance.repository as jupyterInstanceRepository
+
+        return jupyterInstanceRepository.editJupyterInstance(
+            self,
+            startedAt,
+            endedAt,
+            status,
+            errorMessage
+        )

{labstep-3.26.0 → labstep-3.27.0}/labstep/entities/jupyterInstance/repository.py

@@ -2,25 +2,27 @@
 # -*- coding: utf-8 -*-
 # Author: Labstep <dev@labstep.com>
 
-from labstep.entities.jupyterInstance.model import JupyterInstance
 import labstep.generic.entity.repository as entityRepository
 from labstep.constants import UNSPECIFIED
+from labstep.entities.jupyterInstance.model import JupyterInstance
 
 
-def getJupyterInstance(user, guid):
-    return entityRepository.getEntity(user, JupyterInstance, id=guid)
+def getJupyterInstance(user, id):
+    return entityRepository.getEntity(user, JupyterInstance, id)
 
 
 def editJupyterInstance(
     jupyterInstance,
-    data=UNSPECIFIED,
     startedAt=UNSPECIFIED,
-    endedAt=UNSPECIFIED
+    endedAt=UNSPECIFIED,
+    status=UNSPECIFIED,
+    errorMessage=UNSPECIFIED
 ):
     params = {
-        "data": data,
         "started_at": startedAt,
         "ended_at": endedAt,
+        "status": status,
+        "error_message": errorMessage,
     }
 
     return entityRepository.editEntity(jupyterInstance, params)

{labstep-3.26.0 → labstep-3.27.0}/labstep.egg-info/PKG-INFO

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

labstep-3.26.0/labstep/constants/version.py

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

labstep-3.26.0/labstep/entities/jupyterInstance/model.py

@@ -1,92 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-# Author: Labstep <dev@labstep.com>
-
-from labstep.generic.entity.model import Entity
-from labstep.service.helpers import getTime
-
-
-class JupyterInstance(Entity):
-    """
-    Represents an JupyterInstance on Labstep.
-    """
-
-    __entityName__ = "jupyter-instance"
-    __hasGuid__ = True
-
-    def start(self):
-        """
-        Update JupyterInstance to indicate that server instance has started and is ready to use.
-
-        Parameters
-        ----------
-
-        Returns
-        -------
-        :class:`~labstep.entities.jupyterInstance.model.JupyterInstance`
-            An object representing the edited JupyterInstance.
-
-        Example
-        -------
-        ::
-
-            my_jupyterInstance = user.getJupyterInstance("872b3e7e-e21f-4403-9ef3-3650fe0d86ba")
-            my_jupyterInstance.start()
-        """
-        import labstep.entities.jupyterInstance.repository as jupyterInstanceRepository
-
-        return jupyterInstanceRepository.editJupyterInstance(
-            self, startedAt=getTime()
-        )
-
-    def end(self):
-        """
-        Update JupyterInstance to indicate that server instance has shutdown.
-
-        Parameters
-        ----------
-
-        Returns
-        -------
-        :class:`~labstep.entities.jupyterInstance.model.JupyterInstance`
-            An object representing the edited JupyterInstance.
-
-        Example
-        -------
-        ::
-
-            my_jupyterInstance = user.getJupyterInstance("872b3e7e-e21f-4403-9ef3-3650fe0d86ba")
-            my_jupyterInstance.end()
-        """
-        import labstep.entities.jupyterInstance.repository as jupyterInstanceRepository
-
-        return jupyterInstanceRepository.editJupyterInstance(
-            self, endedAt=getTime()
-        )
-
-    def edit(self, data=None, extraParams={}):
-        """
-        Edit an existing JupyterInstance.
-
-        Parameters
-        ----------
-        data (str)
-            JupyterNotebook ipyb JSON data.
-
-        Returns
-        -------
-        :class:`~labstep.entities.jupyterInstance.model.JupyterInstance`
-            An object representing the edited JupyterInstance.
-
-        Example
-        -------
-        ::
-
-            my_jupyterInstance = user.getJupyterInstance("872b3e7e-e21f-4403-9ef3-3650fe0d86ba")
-            my_jupyterInstance.edit(data='{test: 42}')
-        """
-        import labstep.entities.jupyterInstance.repository as jupyterInstanceRepository
-
-        return jupyterInstanceRepository.editJupyterInstance(
-            self, data=data
-        )