labstep 3.25.3__tar.gz → 3.26.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: labstep
-Version: 3.25.3
+Version: 3.26.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

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

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

@@ -0,0 +1,48 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Author: Labstep <dev@labstep.com>
+from deprecated import deprecated
+from labstep.generic.entityWithSharing.model import EntityWithSharing
+from labstep.service.helpers import getTime, handleDate
+from labstep.constants import UNSPECIFIED
+
+
+class CollaboratorRole(EntityWithSharing):
+    """
+    Represents a role a user can have with respect to a particular entity on Labstep i.e. Author, Reviewer, Approver, Assignee, etc.
+
+    """
+
+    __entityName__ = "entity-user-role"
+    __unSearchable__ = True
+
+    def edit(self, name=UNSPECIFIED, description=UNSPECIFIED, extraParams={}):
+        """
+        Edit an existing CollaboratorRole.
+
+        Parameters
+        ----------
+        name (str)
+            The new name of the CollaboratorRole.
+
+        description(str)
+            The new description of the CollaboratorRole.
+
+        Returns
+        -------
+        :class:`~labstep.entities.collaboratorRole.model.CollaboratorRole`
+            An object representing the edited CollaboratorRole.
+
+        Example
+        -------
+        ::
+
+            workspace = user.getWorkspace(17000)
+            my_collaborator_role = workspace.getCollaboratorRole(17000)
+            my_collaborator_role.edit(name='A New CollaboratorRole Name')
+        """
+        import labstep.entities.collaboratorRole.repository as collaboratorRoleRepository
+
+        return collaboratorRoleRepository.editCollaboratorRole(self, name=name, description=description, extraParams=extraParams)
+
+

labstep-3.26.0/labstep/entities/collaboratorRole/repository.py

@@ -0,0 +1,44 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Author: Labstep <dev@labstep.com>
+
+from labstep.entities.collaboratorRole.model import CollaboratorRole
+import labstep.generic.entity.repository as entityRepository
+from labstep.constants import UNSPECIFIED
+
+def addCollaboratorRole(user, group_id, name=UNSPECIFIED, description=UNSPECIFIED, extraParams={}):
+    params = {
+        "group_id": group_id,
+        "name": name,
+        "description": description,
+        **extraParams,
+    }
+    return entityRepository.newEntity(user, CollaboratorRole, params)
+
+def editCollaboratorRole(collaboratorRole, name=UNSPECIFIED,
+                                           description=UNSPECIFIED,
+                                           deleted_at=UNSPECIFIED,
+                                           extraParams={}):
+    params = {
+        "name": name,
+        "description": description,
+        "deleted_at": deleted_at,
+        **extraParams,
+    }
+    return entityRepository.editEntity(collaboratorRole, params)
+
+def getCollaboratorRole(user, collaboratorRole_id):
+    return entityRepository.getEntity(user, CollaboratorRole, id=collaboratorRole_id)
+
+
+def getCollaboratorRoles(user, entity_state_workflow_id=UNSPECIFIED,
+                         group_id=UNSPECIFIED,
+                         count=UNSPECIFIED,
+                         search_query=UNSPECIFIED,
+                         extraParams={}):
+    params = {
+              #'entity_state_workflow_id':entity_state_workflow_id,
+              'group_id':group_id,
+              #"search_query": search_query,
+              **extraParams}
+    return entityRepository.getEntities(user, CollaboratorRole, count, params)

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

@@ -0,0 +1,114 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Author: Labstep <dev@labstep.com>
+from deprecated import deprecated
+from labstep.generic.entity.model import Entity
+from labstep.service.helpers import getTime, handleDate
+from labstep.constants import UNSPECIFIED
+
+
+class CollaboratorRoleRequirement(Entity):
+    """
+    Represents a requirement for a particular Collaborator role to be assigned at a particular state an the EntityStateWorkflow.
+
+    """
+
+    __entityName__ = "entity-user-role-requirement"
+
+    # @property
+    # def signature_requirement(self):
+    #     from labstep.generic.entity.repository import getEntityProperty
+    #     from labstep.entities.signatureRequirement.model import SignatureRequirement
+
+    #     return SignatureRequirement(self.__data__['signature_requirement'], self.__user__)
+    #     #return getEntityProperty(self,'signature_requirement',SignatureRequirement)
+
+    def edit(self, number_required=UNSPECIFIED, collaborator_role_id=UNSPECIFIED, auto_assign=UNSPECIFIED, extraParams={}):
+        """
+        Edit an existing CollaboratorRoleRequirement.
+
+        Parameters
+        ----------
+        number_required (int)
+            The new number of CollaboratorRoleRequirement.
+
+        Returns
+        -------
+        :class:`~labstep.entities.collaboratorRoleRequirement.model.CollaboratorRoleRequirement`
+            An object representing the edited CollaboratorRoleRequirement.
+
+        Example
+        -------
+        ::
+
+            my_entity_state_workflow = user.getEntityStateWorkflow(17000)
+            my_entity_state = my_entity_state_workflow.newEntityState(name='A New EntityState Name')
+            collaborator_requirements=my_entity_state.addRoleRequirement(collaborator_role_id=17000, number_required=4)
+            collaborator_requirements.edit(number_required=2)
+        """
+        import labstep.entities.collaboratorRoleRequirement.repository as collaboratorRoleRequirementRepository
+
+        return collaboratorRoleRequirementRepository.editCollaboratorRoleRequirement(self, number_required=number_required, collaborator_role_id=collaborator_role_id, auto_assign=auto_assign, extraParams=extraParams)
+
+
+
+    def getSignatureRequirement(self):
+        """
+        Get a SignatureRequirement of a Collaborator Role Requirement.
+
+
+        Returns
+        -------
+        :class:`~labstep.entities.signatureRequirement.model.SignatureRequirement`
+            An object representing the SignatureRequirement.
+
+        Example
+        -------
+        ::
+
+            my_entity_state_workflow = user.getEntityStateWorkflow(17000)
+            my_entity_state = my_entity_state_workflow.newEntityState(name='A New EntityState Name')
+            collaborator_req=my_entity_state.addRoleRequirement(collaborator_role_id=17000,
+                                                                         number_required=2
+                                                                         )
+            signature_requirement = collaborator_req.getSignatureRequirement()
+        """
+        import labstep.entities.signatureRequirement.repository as signatureRequirementRepository
+
+        return signatureRequirementRepository.getSignatureRequirement(self.__user__, self)
+
+    def setSignatureRequirement(self, statement=UNSPECIFIED, days_to_sign=UNSPECIFIED, reject_entity_state_id=UNSPECIFIED, extraParams={}):
+        """
+        Set SignatureRequirement of a Collaborator Role Requirement.
+
+        Parameters
+        ----------
+        required (bool)
+            If the SignatureRequirement is required.
+
+        default_statement (str)
+            The default statement of the SignatureRequirement.
+
+        days_to_sign(int)
+            The days to sign of the SignatureRequirement.
+
+        reject_entity_state_id(int)
+            The ID of the entity state on reject of the SignatureRequirement.
+
+        Returns
+        -------
+        :class:`~labstep.entities.signatureRequirement.model.SignatureRequirement`
+            An object representing the edited SignatureRequirement.
+
+        Example
+        -------
+        ::
+
+            my_entity_state_workflow = user.getEntityStateWorkflow(17000)
+            my_entity_state = my_entity_state_workflow.newEntityState(name='A New EntityState Name')
+            collaborator_requirements=my_entity_state.addRoleRequirement(collaborator_role_id=17000, number_required=2)
+            my_signature_requirement = collaborator_requirements.setSignatureRequirement(default_statement='A New SignatureRequirement Default Statement')
+        """
+        import labstep.entities.signatureRequirement.repository as signatureRequirementRepository
+
+        return signatureRequirementRepository.setSignatureRequirement(self.__user__, self, statement=statement, days_to_sign=days_to_sign, reject_entity_state_id=reject_entity_state_id, extraParams=extraParams)

labstep-3.26.0/labstep/entities/collaboratorRoleRequirement/repository.py

@@ -0,0 +1,79 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Author: Labstep <dev@labstep.com>
+
+from labstep.entities.collaboratorRoleRequirement.model import CollaboratorRoleRequirement
+import labstep.generic.entity.repository as entityRepository
+from labstep.generic.entityList.model import EntityList
+from labstep.constants import UNSPECIFIED
+
+def getCollaboratorRoleRequirements(user, entityState):
+    if entityState['entity_user_role_requirements'] is None or entityState['entity_user_role_requirements'] == []:
+        return None
+    else:
+        return CollaboratorRoleRequirement(entityState['entity_user_role_requirements'], user)
+
+def addCollaboratorRoleRequirement(user,
+                                   entity_state,
+                                   entity_user_role_id,
+                                   number_required=1,
+                         extraParams={}):
+    params = {
+        "entity_state_id": entity_state.id,
+        'entity_user_role_id': entity_user_role_id,
+        'number_required': number_required,
+        **extraParams,
+    }
+
+    collab_requirements = entityRepository.newEntity(user, CollaboratorRoleRequirement, params)
+
+    setattr(entity_state,'entity_user_role_requirements', collab_requirements.__dict__)
+    setattr(collab_requirements, 'entity_state_id', entity_state.id)
+
+    return collab_requirements
+
+def editCollaboratorRoleRequirement(collaboratorRoleRequirement,
+                                    number_required=UNSPECIFIED,
+                                    collaborator_role_id=UNSPECIFIED,
+                                    auto_assign=UNSPECIFIED,
+                                    extraParams={}):
+
+    params = {
+        "number_required": number_required,
+        'collaborator_role_id': collaborator_role_id,
+        **extraParams,
+    }
+
+    if auto_assign == 'creator:':
+        params['automation'] = {
+        'type': 'experiment_workflow_create',
+        'trigger_log_type': 'experiment_workflow_created',
+        'filter': [],
+        'action': 'set_entity_user_role',
+        'payload': { 'entity_user_role_id': collaborator_role_id if collaborator_role_id is not UNSPECIFIED else collaboratorRoleRequirement['entity_user_role']['id']} },
+    if auto_assign == 'contributor':
+        params['automation'] ={
+            "type":"experiment_workflow_edit",
+            "trigger_log_type":"experiment_workflow_updated",
+            "filter":[
+                {"type":"and",
+                 "path":"entityStateWorkflow",
+                 "predicates":[
+                     {"attribute":"id",
+                      "comparison":"eq",
+                      "value":collaboratorRoleRequirement['permission_entity_info']['id']}]},
+                {"type":"and","path":"entityState","predicates":[
+                    {"attribute":"id",
+                     "comparison":"eq",
+                     "value":collaboratorRoleRequirement['entity_state_id']}]}],
+            "action":"set_entity_user_role",
+            "payload":{
+                "entity_user_role_id":collaborator_role_id if collaborator_role_id is not UNSPECIFIED else collaboratorRoleRequirement['entity_user_role']['id']
+                }}
+
+
+
+
+
+    return entityRepository.editEntity(collaboratorRoleRequirement, params)
+

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

@@ -0,0 +1,108 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Author: Labstep <dev@labstep.com>
+from labstep.generic.entity.model import Entity
+from labstep.constants import UNSPECIFIED
+
+
+class EntityState(Entity):
+    """
+    Represents an Entity State Workflow on Labstep.
+
+    """
+
+    __entityName__ = "entity-state"
+    __unSearchable__ = True
+    __noDelete__ = True
+
+    def edit(self, name=UNSPECIFIED, color=UNSPECIFIED, state_type=UNSPECIFIED, extraParams={}):
+        """
+        Edit an existing EntityState.
+
+        Parameters
+        ----------
+        name (str)
+            The new name of the EntityState.
+
+        color in HEX vaue(str)
+            The new color of the EntityState.
+
+        type(str)
+            The new type of the EntityState. It can be one of the following: 'unstarted',
+            'started', and 'complete'.
+
+        Returns
+        -------
+        :class:`~labstep.entities.entityState.model.EntityState`
+            An object representing the edited EntityState.
+
+        Example
+        -------
+        ::
+
+            my_entity_state_workflow = user.getEntityStateWorkflow(17000)
+            my_entity_state = my_entity_state_workflow.getEntityState(17000)
+            my_entity_state.edit(name='A New EntityState Name')
+        """
+        import labstep.entities.entityState.repository as entityStateRepository
+
+        return entityStateRepository.editEntityState(self, name=name, color=color, state_type=state_type, extraParams=extraParams)
+
+
+
+    def addRoleRequirement(self, collaborator_role_id, number_required=1, extraParams={}):
+        """
+        Create a new RoleRequirement.
+
+        Parameters
+        ----------
+        collaborator_rol_id (int)
+            ID of the collaborator role.
+
+        number_required(int)
+            Number of collaborators required.
+
+
+        Returns
+        -------
+        :class:`~labstep.entities.collaboratorRoleRequirement.model.CollaboratorRoleRequirement`
+            An object representing the edited CollaboratorRoleRequirement.
+
+        Example
+        -------
+        ::
+
+            my_entity_state_workflow = user.getEntityStateWorkflow(17000)
+            collaborator_role = workspace.getCollaboratorRole(17000)
+            my_entity_state = my_entity_state_workflow.getEntityStates()
+            my_entity_state[0].addRoleRequirement(entity_user_role_id=collaborator_role.id,
+                                                  number_required=2
+                                                  )
+        """
+        import labstep.entities.collaboratorRoleRequirement.repository as collaboratorRoleRequirementRepository
+
+        return collaboratorRoleRequirementRepository.addCollaboratorRoleRequirement(self.__user__,
+                                                                                    entity_state= self,
+                                                                                    entity_user_role_id=collaborator_role_id,
+                                                                                    number_required=number_required,
+                                                                                    extraParams=extraParams)
+
+    def getCollaboratorRoleRequirements(self):
+        """
+        Get all RoleRequirements of an EntityState.
+
+        Returns
+        -------
+        List[:class:`~labstep.entities.collaboratorRoleRequirement.model.CollaboratorRoleRequirement`]
+            A list of objects representing CollaboratorRoleRequirements.
+
+        Example
+        -------
+        ::
+
+            my_entity_state = entityWorkflow.getEntityState(17000)
+            role_requirements = my_entity_state.getCollaboratorRoleRequirements()
+        """
+        import labstep.entities.collaboratorRoleRequirement.repository as collaboratorRoleRequirementRepository
+
+        return collaboratorRoleRequirementRepository.getCollaboratorRoleRequirements(self.__user__, self)

labstep-3.26.0/labstep/entities/entityState/repository.py

@@ -0,0 +1,56 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Author: Labstep <dev@labstep.com>
+
+from labstep.entities.entityState.model import EntityState
+import labstep.generic.entity.repository as entityRepository
+from labstep.constants import UNSPECIFIED
+
+
+def addEntityState(user, name,
+                         color='#b5e550',
+                         type='unstarted',
+                         entity_state_workflow_id=UNSPECIFIED,
+                         extraParams={}):
+    params = {
+        "name": name,
+        'color': color,
+        'type': type,
+        'entity_state_workflow_id': entity_state_workflow_id,
+        **extraParams,
+    }
+    return entityRepository.newEntity(user, EntityState, params)
+
+def editEntityState(entityState, name=UNSPECIFIED,
+                                 color=UNSPECIFIED,
+                                 state_type=UNSPECIFIED,
+                                 extraParams={}):
+    params = {
+        "name": name,
+        'color': color,
+        'type': state_type,
+        **extraParams,
+    }
+    return entityRepository.editEntity(entityState, params)
+
+def getEntityState(user, entity_state_id, entity_state_workflow_id=UNSPECIFIED, group_id=UNSPECIFIED):
+
+    extraParams = {
+        "get_single": 1,
+        'entity_state_workflow_id': entity_state_workflow_id,
+        'group_id': group_id
+    }
+
+    return entityRepository.getEntity(user,EntityState,entity_state_id,extraParams=extraParams)
+
+
+def getEntityStates(user, entity_state_workflow_id=UNSPECIFIED,
+                         count=UNSPECIFIED,
+                         search_query=UNSPECIFIED,
+                         extraParams={}):
+    params = {
+              'entity_state_workflow_id':entity_state_workflow_id,
+              "search_query": search_query,
+              **extraParams}
+    return entityRepository.getEntities(user, EntityState, count, params)
+

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

@@ -0,0 +1,130 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Author: Labstep <dev@labstep.com>
+from deprecated import deprecated
+
+from labstep.generic.entityWithSharing.model import EntityWithSharing
+from labstep.generic.entityWithAssign.model import EntityWithAssign
+from labstep.service.helpers import getTime, handleDate
+from labstep.constants import UNSPECIFIED
+
+
+class EntityStateWorkflow(EntityWithSharing,EntityWithAssign):
+    """
+    Represents a series of states an entity must go through, including who needs to sign / be assigned at each stage.
+
+    """
+
+    __entityName__='entity-state-workflow'
+    __hasParentGroup__ = True
+
+    def edit(self, name=UNSPECIFIED, extraParams={}):
+        """
+        Edit an existing EntityStateWorkflow.
+
+        Parameters
+        ----------
+        name (str)
+            The new name of the EntityStateWorkflow.
+
+        Returns
+        -------
+        :class:`~labstep.entities.EntityStateWorkflow.model.EntityStateWorkflow`
+            An object representing the edited EntityStateWorkflow.
+
+        Example
+        -------
+        ::
+
+            my_entity_state_workflow = user.getEntityStateWorkflow(17000)
+            my_entity_state_workflow.edit(name='A New EntityStateWorkflow Name')
+        """
+        import labstep.entities.entityStateWorkflow.repository as entityStateWorkflowRepository
+
+        return entityStateWorkflowRepository.editEntityStateWorkflow(self, name=name, extraParams=extraParams)
+
+
+    def newEntityState(self, name, color='#0057dd', type='unstarted', extraParams={}):
+        """
+        Add an EntityState to an EntityStateWorkflow.
+
+        Parameters
+        ----------
+        name (str)
+            The name of the EntityState.
+
+        color in HEX value(str)
+            The color of the EntityState.
+
+        type(str)
+            The type of the EntityState. It can be one of the following: 'unstarted',
+            'started', and 'complete'.
+
+
+        Returns
+        -------
+        :class:`~labstep.entities.entityState.model.EntityState`
+            An object representing the EntityState.
+
+        Example
+        -------
+        ::
+
+            my_entity_state_workflow = user.getEntityStateWorkflow(17000)
+            my_entity_state_workflow.newEntityState(name='A New EntityState Name')
+        """
+        import labstep.entities.entityState.repository as entityStateRepository
+        return entityStateRepository.addEntityState(self.__user__, name, color, type,  self.id, extraParams=extraParams)
+
+    def getEntityState(self, entity_state_id):
+        """
+        Get an EntityState in an EntityStateWorkflow.
+
+        Parameters
+        ----------
+        entity_state_id(int)
+            The ID of the EntityState.
+
+        Returns
+        -------
+        :class:`~labstep.entities.entityState.model.EntityState`
+            An object representing the EntityState.
+
+        Example
+        -------
+        ::
+
+            my_entity_state_workflow = user.getEntityStateWorkflow(17000)
+            my_entity_state_workflow.getEntityState(17000)
+        """
+        import labstep.entities.entityState.repository as entityStateRepository
+        return entityStateRepository.getEntityState(self.__user__, entity_state_id, entity_state_workflow_id=self.id)
+
+    def getEntityStates(self, count=UNSPECIFIED, search_query=UNSPECIFIED, extraParams={}):
+        """
+        Get all EntityStates in an EntityStateWorkflow.
+
+        Parameters
+        ----------
+
+        count(int)
+            The number of EntityStates to return.
+
+        search_query(str)
+            The search query to filter EntityStates.
+
+        Returns
+        -------
+        :class:`~labstep.entities.entityState.model.EntityState`
+            An object representing the EntityState.
+
+        Example
+        -------
+        ::
+
+            my_entity_state_workflow = user.getEntityStateWorkflow(17000)
+            my_entity_state_workflow.getEntityStates()
+        """
+        import labstep.entities.entityState.repository as entityStateRepository
+
+        return entityStateRepository.getEntityStates(self.__user__, self.id, count=count, search_query=search_query, extraParams=extraParams)

labstep-3.26.0/labstep/entities/entityStateWorkflow/repository.py

@@ -0,0 +1,44 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Author: Labstep <dev@labstep.com>
+
+from labstep.entities.entityStateWorkflow.model import EntityStateWorkflow
+import labstep.generic.entity.repository as entityRepository
+from labstep.constants import UNSPECIFIED
+
+
+def newEntityStateWorkflow(user,
+                           name,
+                           target_entity='ExperimentWorkflow',
+                           group_id=UNSPECIFIED,
+                           extraParams={}):
+    params = {
+        'name': name,
+        #'target_entity_class': target_entity.__entityName__,
+        'target_entity_class': target_entity,
+        'group_id': group_id,
+        **extraParams,
+    }
+    return entityRepository.newEntity(user, EntityStateWorkflow, fields = params)
+
+def editEntityStateWorkflow(entityStateWorkflow,
+                            name=UNSPECIFIED,
+                            extraParams={}):
+    params = {
+        'name': name,
+        **extraParams,
+    }
+    return entityRepository.editEntity(entityStateWorkflow, params)
+
+def getEntityStateWorkflow(user, entity_state_workflow_id):
+    return entityRepository.getEntity(user, EntityStateWorkflow, id=entity_state_workflow_id)
+
+
+def getEntityStateWorkflows(user,
+                            search_query=UNSPECIFIED,
+                            count=UNSPECIFIED,
+                            extraParams={}):
+    params = {'search_query': search_query,
+              **extraParams}
+    return entityRepository.getEntities(user, EntityStateWorkflow, count, params)
+