add code envs

Author: FChataigner

dataikuapi/dss/admin.py

@@ -1,4 +1,5 @@
 from .future import DSSFuture
+import json
 
 class DSSConnection(object):
     """
@@ -417,3 +418,85 @@ def group_regexp(self, regexp, unix_user, hadoop_user=None):
         self.raw['targetUnix'] = unix_user
         self.raw['targetHadoop'] = hadoop_user
         return self
+
+class DSSCodeEnv(object):
+    """
+    A code env on the DSS instance
+    """
+    def __init__(self, client, env_lang, env_name):
+        self.client = client
+        self.env_lang = env_lang
+        self.env_name = env_name
+    
+    ########################################################
+    # Env deletion
+    ########################################################
+    
+    def delete(self):
+        """
+        Delete the connection
+
+        Note: this call requires an API key with admin rights
+        """
+        resp = self.client._perform_json(
+            "DELETE", "/admin/code-envs/%s/%s" % (self.env_lang, self.env_name))
+        if resp is None:
+            raise Exception('Env deletion returned no data')
+        if resp.get('messages', {}).get('error', False):
+            raise Exception('Env deletion failed : %s' % (json.dumps(resp.get('messages', {}).get('messages', {}))))
+    
+        
+    ########################################################
+    # Code env description
+    ########################################################
+    
+    def get_definition(self):
+        """
+        Get the code env's definition
+
+        Note: this call requires an API key with admin rights
+        
+        Returns:
+            the code env definition, as a JSON object
+        """
+        return self.client._perform_json(
+            "GET", "/admin/code-envs/%s/%s" % (self.env_lang, self.env_name))
+    
+    ########################################################
+    # Code env modification
+    ########################################################
+    def update(self, external_conda_name=None, conda_spec=None, spec=None):
+        """
+        Update the code env definition and apply the changes
+        
+        Note: this call requires an API key with admin rights
+        
+        :param external_conda_name: name of an external conda env
+        :param conda_spec: spec of the conda env
+        :param spec: list of pip or R packages
+        """
+        modifications = {'externalCondaEnvName':external_conda_name,'condaSpec':conda_spec,'spec':spec}
+        resp = self.client._perform_json(
+            "PUT", "/admin/code-envs/%s/%s" % (self.env_lang, self.env_name),
+            body = modifications)
+        if resp is None:
+            raise Exception('Env update returned no data')
+        if resp.get('messages', {}).get('error', False):
+            raise Exception('Env update failed : %s' % (json.dumps(resp.get('messages', {}).get('messages', {}))))
+
+    def set_jupyter_support(self, active):
+        """
+        Update the code env jupyter support
+        
+        Note: this call requires an API key with admin rights
+        
+        :param active: True to activate jupyter support, False to deactivate
+        """
+        resp = self.client._perform_json(
+            "POST", "/admin/code-envs/%s/%s/jupyter" % (self.env_lang, self.env_name),
+            params = {'active':active})
+        if resp is None:
+            raise Exception('Env update returned no data')
+        if resp.get('messages', {}).get('error', False):
+            raise Exception('Env update failed : %s' % (json.dumps(resp.get('messages', {}).get('messages', {}))))
+

dataikuapi/dssclient.py

@@ -6,7 +6,7 @@
 from dss.future import DSSFuture
 from dss.project import DSSProject
 from dss.plugin import DSSPlugin
-from dss.admin import DSSUser, DSSGroup, DSSConnection, DSSGeneralSettings
+from dss.admin import DSSUser, DSSGroup, DSSConnection, DSSGeneralSettings, DSSCodeEnv
 from dss.meaning import DSSMeaning
 from dss.sqlquery import DSSSQLQuery
 from dss.notebook import DSSNotebook
@@ -316,7 +316,7 @@ def list_connections(self):
         Note: this call requires an API key with admin rights
         
         Returns:
-			All connections, as a map of connection name to connection definition
+            All connections, as a map of connection name to connection definition
         """
         return self._perform_json(
             "GET", "/admin/connections/")
@@ -360,6 +360,58 @@ def create_connection(self, name, type=None, params=None, usable_by='ALL', allow
                })
         return DSSConnection(self, name)
 
+    ########################################################
+    # Code envs
+    ########################################################
+
+    def list_code_envs(self):
+        """
+        List all code envs setup on the DSS instance
+
+        Note: this call requires an API key with admin rights
+        
+        Returns:
+            List code envs (name, type, language)
+        """
+        return self._perform_json(
+            "GET", "/admin/code-envs/")
+
+    def get_code_env(self, env_lang, env_name):
+        """
+        Get a handle to interact with a specific code env
+        
+        Args:
+            name: the name of the desired code env
+        
+        Returns:
+            A :class:`dataikuapi.dss.admin.DSSCodeEnv` code env  handle
+        """
+        return DSSCodeEnv(self, env_lang, env_name)
+
+    def create_code_env(self, env_lang, env_name, deployment_mode, params=None):
+        """
+        Create a code env, and return a handle to interact with it
+
+        Note: this call requires an API key with admin rights
+
+        :param env_lang: the language (Python, R) of the new code env
+        :param env_name: the name of the new code env
+        :param deployment_mode: the type of the new code env
+        :param params: the parameters of the new connection, as a JSON object
+        
+        :returns: A :class:`dataikuapi.dss.admin.DSSCodeEnv` code env handle
+        
+        """
+        params = params if params is not None else {}
+        params['deploymentMode'] = deployment_mode
+        resp = self._perform_json(
+               "POST", "/admin/code-envs/%s/%s" % (env_lang, env_name), body=params)
+        if resp is None:
+            raise Exception('Env creation returned no data')
+        if resp.get('messages', {}).get('error', False):
+            raise Exception('Env creation failed : %s' % (json.dumps(resp.get('messages', {}).get('messages', {}))))
+        return DSSCodeEnv(self, env_lang, env_name)
+
     ########################################################
     # Meanings
     ########################################################