WIP

Author: FChataigner

dataikuapi/dss/admin.py

@@ -1,5 +1,6 @@
 from .future import DSSFuture
 import json, warnings
+from datetime import datetime
 
 class DSSConnectionInfo(dict):
     """A class holding read-only information about a connection.
@@ -1271,3 +1272,80 @@ def total_scenarios_count(self):
     @property
     def total_active_with_trigger_scenarios_count(self):
         return self.data["scenarios"]["activeWithTriggers"]
+
+
+class DSSKubikleTemplateListItem(object):
+    """An item in a list of datasets. Do not instantiate this class, use :meth:`dataikuapi.dss.project.DSSProject.list_datasets`"""
+    def __init__(self, client, data):
+        self.client = client
+        self._data = data
+
+    def to_kubikle_template(self):
+        """Gets the :class:`DSSKubikleTemplate` corresponding to this kubikle template """
+        return DSSKubikleTemplate(self.client, self._data["id"])
+
+    @property
+    def name(self):
+        return self._data["name"]
+    @property
+    def id(self):
+        return self._data["id"]
+    @property
+    def type(self):
+        return self._data["type"]
+    @property
+    def type_label(self):
+        return self._data.get("desc", {}).get("label", self._data["type"])
+    @property
+    def type_description(self):
+        return self._data.get("desc", {}).get("description", self._data["type"])
+    @property
+    def build_for_configs(self):
+        return self._data.get("buildFor", [])
+    @property
+    def last_built(self):
+        ts = self._data.get("lastBuilt", 0)
+        if ts > 0:
+            return datetime.fromtimestamp(ts / 1000)
+        else:
+            return None
+
+class DSSKubikleTemplate(object):
+    """
+    A handle to interact with a kubikle template on the DSS instance
+    """
+    def __init__(self, client, template_id):
+        """Do not call that directly, use :meth:`dataikuapi.DSSClient.get_kubikle_template`"""
+        self.client = client
+        self.template_id = template_id
+            
+    ########################################################
+    # Template description
+    ########################################################
+    
+    def get_settings(self):
+        """
+        Get the template's settings. 
+
+        :returns: a :class:`DSSKubikleTemplateSettings` object to interact with kubikle template settings
+        :rtype: :class:`DSSKubikleTemplateSettings`
+        """
+        settings = self.client._perform_json("GET", "/admin/kubikles/%s" % (self.template_id))
+        return DSSKubikleTemplateSettings(self.client, self.template_id, settings)
+
+class DSSKubikleTemplateSettings(object):
+    """
+    The settings of a kubikle template
+    """
+    def __init__(self, client, template_id, settings):
+        """Do not call directly, use :meth:`DSSKubikleTemplate.get_settings`"""
+        self.client = client
+        self.template_id = template_id
+        self.settings = settings
+
+    def get_raw(self):
+        """
+        Gets all settings as a raw dictionary. This returns a reference to the raw settings, not a copy,
+        """
+        return self.settings
+

dataikuapi/dss/kubikle.py

@@ -0,0 +1,41 @@
+from ..utils import DataikuException
+import json
+
+class DSSKubikleObject(object):
+    """
+    A handle to manage a kubikle object of a project
+    """
+    def __init__(self, client, project_key, kubikle_object_id):
+        """Do not call directly, use :meth:`dataikuapi.dss.project.DSSProject.get_kubikle_object`"""
+        self.client = client
+        self.project_key = project_key
+        self.kubikle_object_id = kubikle_object_id
+
+    def get_settings(self):
+        """
+        Get the kubikle object's settings
+
+        :returns: a handle to manage the wiki settings (taxonomy, home article)
+        :rtype: :class:`dataikuapi.dss.kubikle.DSSKubikleObjectSettings`
+        """
+        settings = self.client._perform_json("GET", "/projects/%s/kubikles/%s" % (self.project_key, self.kubikle_object_id))
+        return DSSKubikleObjectSettings(self.client, self.project_key, self.kubikle_object_id, settings)
+
+
+class DSSKubikleObjectSettings(object):
+    """
+    Settings for the kubikle object
+    """
+    def __init__(self, client, project_key, kubikle_object_id, settings):
+        """Do not call directly, use :meth:`dataikuapi.dss.kubikle.DSSKubikleObject.get_settings`"""
+        self.client = client
+        self.project_key = project_key
+        self.kubikle_object_id = kubikle_object_id
+        self.settings = settings
+
+    def get_raw(self):
+        """
+        Gets all settings as a raw dictionary. This returns a reference to the raw settings, not a copy,
+        """
+        return self.settings
+

dataikuapi/dss/project.py

@@ -25,7 +25,7 @@
 from .analysis import DSSAnalysis
 from .flow import DSSProjectFlow
 from .app import DSSAppManifest
-
+from .kubikle import DSSKubikleObject
 
 class DSSProject(object):
     """
@@ -1606,6 +1606,7 @@ def get_app_manifest(self):
         raw_data = self.client._perform_json("GET", "/projects/%s/app-manifest" % self.project_key)
         return DSSAppManifest(self.client, raw_data, self.project_key)
 
+    ########################################################
     # MLflow experiment tracking
     ########################################################
     def setup_mlflow(self, managed_folder, host=None):
@@ -1626,6 +1627,55 @@ def get_mlflow_extension(self):
         """
         return DSSMLflowExtension(client=self.client, project_key=self.project_key)
 
+
+
+    ########################################################
+    # Kubikles
+    ########################################################
+    def list_kubikle_objects(self):
+        """
+        List the kubikle objects in this project
+        
+        Returns:
+            the list of the kubikle objects, each one as a JSON object
+        """
+        return self.client._perform_json(
+            "GET", "/projects/%s/kubikles/" % self.project_key)
+
+    def get_kubikle_object(self, kubikle_object_id):
+        """
+        Get a handle to interact with a specific kubikle object
+       
+        Args:
+            kubikle_object_id: the identifier of the desired kubikle object
+        
+        Returns:
+            A :class:`dataikuapi.dss.kubikle.DSSKubikleObject` kubikle object handle
+        """
+        return DSSKubikleObject(self.client, self.project_key, kubikle_object_id)
+
+    def create_kubikle_object(self, name, template_id):
+        """
+        Create a new kubikle object in the project, and return a handle to interact with it
+        
+        Args:
+            name: the name of the kubikle object
+            template_id: the identifier of a kubikle template
+        
+        Returns:
+            A :class:`dataikuapi.dss.kubikle.DSSKubikleObject` kubikle object handle
+        """
+        obj = {
+            "name" : name,
+            "projectKey" : self.project_key,
+            "templateId" : template_id
+        }
+        res = self.client._perform_json("POST", "/projects/%s/kubikles/" % self.project_key, body = obj)
+        kubikle_object_id = res['id']
+        return DSSKubikleObject(self.client, self.project_key, kubikle_object_id)
+
+
+
 class TablesImportDefinition(object):
     """
     Temporary structure holding the list of tables to import

dataikuapi/dssclient.py

@@ -11,7 +11,7 @@
 from .dss.project import DSSProject
 from .dss.app import DSSApp
 from .dss.plugin import DSSPlugin
-from .dss.admin import DSSUser, DSSOwnUser, DSSGroup, DSSConnection, DSSGeneralSettings, DSSCodeEnv, DSSGlobalApiKey, DSSCluster, DSSGlobalUsageSummary, DSSInstanceVariables
+from .dss.admin import DSSUser, DSSOwnUser, DSSGroup, DSSConnection, DSSGeneralSettings, DSSCodeEnv, DSSGlobalApiKey, DSSCluster, DSSKubikleTemplate, DSSKubikleTemplateListItem, DSSGlobalUsageSummary, DSSInstanceVariables
 from .dss.meaning import DSSMeaning
 from .dss.sqlquery import DSSSQLQuery
 from .dss.discussion import DSSObjectDiscussions
@@ -593,6 +593,39 @@ def create_cluster(self, cluster_name, cluster_type='manual', params=None):
             raise Exception('Cluster creation failed : %s' % (json.dumps(resp.get('messages', {}).get('messages', {}))))
         return DSSCluster(self, resp['id'])
 
+
+    ########################################################
+    # Kubikle templates
+    ########################################################
+
+    def list_kubikle_templates(self, as_type='listitems'):
+        """
+        List all kubikle templates on the DSS instance
+
+        Returns:
+            List of templates (name, type)
+        """
+        items = self._perform_json("GET", "/admin/kubikles/")
+        if as_type == "listitems" or as_type == "listitem":
+            return [DSSKubikleTemplateListItem(self, item) for item in items]
+        elif as_type == "objects" or as_type == "object":
+            return [DSSKubikleTemplate(self, item["id"]) for item in items]
+        else:
+            raise ValueError("Unknown as_type") 
+
+    def get_kubikle_template(self, template_id):
+        """
+        Get a handle to interact with a specific kubikle template
+        
+        Args:
+            template_id: the template id of the desired kubikle template
+        
+        Returns:
+            A :class:`dataikuapi.dss.admin.DSSKubikleTemplate` kubikle template handle
+        """
+        return DSSKubikleTemplate(self, template_id)
+
+
     ########################################################
     # Global API Keys
     ########################################################