labstep 3.25.0__tar.gz → 3.25.2__tar.gz

{labstep-3.25.0 → labstep-3.25.2}/PKG-INFO

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

labstep-3.25.2/labstep/constants/version.py

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

{labstep-3.25.0 → labstep-3.25.2}/labstep/entities/experimentDataField/repository.py

@@ -142,6 +142,9 @@ def getDataFieldValue(dataField):
 
         keys = [k for k, v in dataField.options['values'].items() if v]
 
+        if keys == []:
+            return None
+
         if dataField.options['is_allow_multiple']:
             return keys
 

{labstep-3.25.0 → labstep-3.25.2}/labstep/entities/notification/model.py

@@ -7,5 +7,10 @@ from labstep.constants import UNSPECIFIED
 from labstep.service.helpers import getTime
 
 class Notification(Entity):
+    """
+    Represents a Notification entity on Labstep.
+    """
+    
     __entityName__='notification'
-    __unSearchable__=True
+    __unSearchable__=True
+    __noDelete__=True

{labstep-3.25.0 → labstep-3.25.2}/labstep/entities/notification/repository.py

@@ -4,17 +4,17 @@ from labstep.constants import UNSPECIFIED
 
 
 def getNotification(user,
-                    guid,):
-    return getEntity(user, Notification, guid=guid)
+                    id,):
+    return getEntity(user, Notification, id=id)
 
 
 def getNotifications(user,
                      count=UNSPECIFIED,
-                     type=UNSPECIFIED,
+                     notification_type=UNSPECIFIED,
                      extraParams={},):
 
     params = {
-        'type': type,
+        'type': notification_type,
         **extraParams,
     }
     return getEntities(user, Notification, count, params)

{labstep-3.25.0 → labstep-3.25.2}/labstep/entities/user/model.py

@@ -1265,6 +1265,8 @@ class User(Entity):
             The number of API keys to retrieve.
         search_query (str)
             Search for API keys with this 'name'.
+        api_key (str)
+            Search for API keys with this 'api_key'.
 
         Returns
         -------
@@ -1275,7 +1277,7 @@ class User(Entity):
         -------
         ::
 
-            entity = user.getAPIKey(search_query='properties')
+            entity = user.getAPIKeys(api_key='111f321dafd0d0sa')
         """
         import labstep.entities.apiKey.repository as ApiKeyRepository
 
@@ -1287,7 +1289,7 @@ class User(Entity):
             extraParams=extraParams,
         )
 
-    def getNotifications(self, count=UNSPECIFIED, type=UNSPECIFIED):
+    def getNotifications(self, count=UNSPECIFIED, notification_type=UNSPECIFIED):
         """
         Retrieve a list of the User's notifications which can be filtered using the parameters
 
@@ -1314,9 +1316,9 @@ class User(Entity):
         """
         import labstep.entities.notification.repository as notificationRepository
 
-        return notificationRepository.getNotifications(self, count=count, type=type)
+        return notificationRepository.getNotifications(self, count=count, notification_type=notification_type)
 
-    def getNotification(self, guid):
+    def getNotification(self, id):
         """
         Retrieve a Notification entity in Labstep.
 
@@ -1338,7 +1340,7 @@ class User(Entity):
         """
         import labstep.entities.notification.repository as notificationRepository
 
-        return notificationRepository.getNotification(self, guid=guid)
+        return notificationRepository.getNotification(self, id=id)
 
     def newPurchaseOrder(self ,name=UNSPECIFIED, status=UNSPECIFIED, currency='USD', extraParams={}):
         """

{labstep-3.25.0 → labstep-3.25.2}/labstep/entities/workspaceRole/model.py

@@ -53,6 +53,14 @@ class WorkspaceRole(Entity):
             Returns
             -------
             None
+
+            Example
+            -------
+            ::
+
+                my_org = user.getOrganization()
+                workspace_role = my_org.getWorkspaceRole(10000)
+                workspace_role.delete()
         """
         import labstep.entities.workspaceRole.repository as WorkspaceRoleRepository
 
@@ -83,6 +91,7 @@ class WorkspaceRole(Entity):
             Example
             -------
             ::
+
                 from labstep.entities.experiment.model import Experiment
 
                 my_org = user.getOrganization()
@@ -97,11 +106,22 @@ class WorkspaceRole(Entity):
         """
             Return a list of the permissions that have been granted to this Workspace Role.
 
+            Parameters
+            -------
+            None
+
             Returns
             -------
             List[:class:`~labstep.entities.workspaceRolePermission.model.WorkspaceRolePermission`]
             An object representing the permission granted to the Workspace Role.
 
+            Example
+            -------
+            ::
+
+                my_org = user.getOrganization()
+                workspace_role = my_org.getWorkspaceRole('Lab Manager')
+                permissions = workspace_role.getPermissions()
 
         """
         from labstep.entities.workspaceRolePermission.model import WorkspaceRolePermission

{labstep-3.25.0 → labstep-3.25.2}/labstep/entities/workspaceRolePermission/model.py

@@ -22,6 +22,16 @@ class WorkspaceRolePermission(Entity):
             Returns
             -------
             None
+
+            Example
+            -------
+            ::
+
+                my_org = user.getOrganization()
+                workspace_role = my_org.getWorkspaceRole('Lab Manager')
+                permissions = workspace_role.getPermissions()
+                permissions[0].revoke()
+        
         """
         import labstep.entities.workspaceRolePermission.repository as WorkspaceRolePermission
 

{labstep-3.25.0 → labstep-3.25.2}/labstep/generic/entity/repository.py

@@ -43,8 +43,10 @@ def getEntity(user, entityClass, id, isDeleted="both", useGuid=False, extraParam
     identifier = 'guid' if getattr(
         entityClass, "__hasGuid__", None) or useGuid else 'id'
 
-    params = {"is_deleted": isDeleted,
-              "get_single": 1, identifier: id, **extraParams}
+    params = {"get_single": 1, identifier: id, **extraParams}
+
+    if not getattr(entityClass, "__noDelete__", None):
+        params['is_deleted']=isDeleted
 
     headers = getHeaders(user=user)
     url = url_join(configService.getHost(), "/api/generic/",

{labstep-3.25.0 → labstep-3.25.2}/labstep.egg-info/PKG-INFO

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

labstep-3.25.0/labstep/constants/version.py

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