Merge remote-tracking branch 'origin/release/5.1'

Author: cstenac

dataikuapi/dss/project.py

@@ -646,14 +646,14 @@ def get_scenario(self, scenario_id):
         """
         return DSSScenario(self.client, self.project_key, scenario_id)
 
-    def create_scenario(self, scenario_name, type, definition={}):
+    def create_scenario(self, scenario_name, type, definition={'params': {}}):
         """
         Create a new scenario in the project, and return a handle to interact with it
 
         :param str scenario_name: The name for the new scenario. This does not need to be unique
                                 (although this is strongly recommended)
         :param str type: The type of the scenario. MUst be one of 'step_based' or 'custom_python'
-        :param object definition: the JSON definition of the scenario. Use ``get_definition`` on an 
+        :param object definition: the JSON definition of the scenario. Use ``get_definition(with_status=False)`` on an
                 existing ``DSSScenario`` object in order to get a sample definition object
 
         :returns: a :class:`.scenario.DSSScenario` handle to interact with the newly-created scenario
@@ -820,6 +820,82 @@ def get_object_discussions(self):
         """
         return DSSObjectDiscussions(self.client, self.project_key, "PROJECT", self.project_key)
 
+    ########################################################
+    # Tables import
+    ########################################################
+
+    def init_tables_import(self):
+        """
+        Start an operation to import Hive or SQL tables as datasets into this project
+
+        :returns: a :class:`TablesImportDefinition` to add tables to import
+        :rtype: :class:`TablesImportDefinition`
+        """
+        return TablesImportDefinition(self.client, self.project_key)
+
+class TablesImportDefinition(object):
+    """
+    Temporary structure holding the list of tables to import
+    """
+
+    def __init__(self, client, project_key):
+        """Do not call this directly, use :meth:`DSSProject.init_tables_import`"""
+        self.client = client
+        self.project_key = project_key
+        self.keys = []
+
+    def add_hive_table(self, hive_database, hive_table):
+        """Add a Hive table to the list of tables to import"""
+        self.keys.append({
+            "connectionName" : "@virtual(hive-jdbc):" + hive_database,
+            "name" : hive_table
+        })
+
+    def add_sql_table(self, connection, schema, table):
+        """Add a SQL table to the list of table to import"""
+        self.keys.append({
+            "connectionName" : connection,
+            "schema": schema,
+            "name" : table
+        })
+
+    def prepare(self):
+        """
+        Run the first step of the import process. In this step, DSS will check
+        the tables whose import you have requested and prepare dataset names and 
+        target connections
+
+        :returns: a :class:`TablesPreparedImport` object that allows you to finalize the import process
+        :rtype: :class:`TablesPreparedImport`
+
+        """
+        ret = self.client._perform_json("POST", "/projects/%s/datasets/tables-import/actions/prepare-from-keys" % (self.project_key),
+                body = {"keys": self.keys} )
+
+        future = self.client.get_future(ret["jobId"])
+        future.wait_for_result()
+        return TablesPreparedImport(self.client, self.project_key, future.get_result())
+
+class TablesPreparedImport(object):
+    """Result of preparing a tables import. Import can now be finished"""
+    
+    def __init__(self, client, project_key, candidates):
+        """Do not call this directly, use :meth:`DSSProject.init_tables_import` and then prepare"""
+        self.client = client
+        self.project_key = project_key
+        self.candidates = candidates
+
+    def execute(self):
+        """
+        Starts executing the import in background and returns a :class:`dataikuapi.dss.future.DSSFuture` to wait on the result
+
+        :returns: a future to wait on the result
+        :rtype: :class:`dataikuapi.dss.future.DSSFuture`
+        """
+        ret = self.client._perform_json("POST", "/projects/%s/datasets/tables-import/actions/execute-from-candidates" % (self.project_key),
+                body = self.candidates)
+        return self.client.get_future(ret["jobId"])
+
 class DSSProjectSettings(object):
     """Settings of a DSS project"""
 

dataikuapi/dss/recipe.py

@@ -28,22 +28,21 @@ def delete(self):
 
     def get_definition_and_payload(self):
         """
-        Get the definition of the recipe
+        Gets the definition of the recipe
 
-        Returns:
-            the definition, as a DSSRecipeDefinitionAndPayload object, containing the recipe definition itself and its payload
+        :returns: the definition, as a :py:class:`DSSRecipeDefinitionAndPayload` object, containing the recipe definition itself and its payload
+        :rtype: :py:class:`DSSRecipeDefinitionAndPayload`
         """
         data = self.client._perform_json(
                 "GET", "/projects/%s/recipes/%s" % (self.project_key, self.recipe_name))
         return DSSRecipeDefinitionAndPayload(data)
 
     def set_definition_and_payload(self, definition):
         """
-        Set the definition of the recipe
+        Sets and saves the definition of the recipe
 
-        Args:
-            definition: the definition, as a DSSRecipeDefinitionAndPayload object. You should only set a definition object 
-            that has been retrieved using the get_definition call.
+        :param definition object: the definition, as a :py:class:`DSSRecipeDefinitionAndPayload` object. You should only set a definition object 
+            that has been retrieved using the :py:meth:get_definition_and_payload call.
         """
         return self.client._perform_json(
                 "PUT", "/projects/%s/recipes/%s" % (self.project_key, self.recipe_name),

dataikuapi/dssclient.py

@@ -596,6 +596,17 @@ def get_log(self, name):
         return self._perform_json(
             "GET", "/admin/logs/%s" % name)
 
+    def log_custom_audit(self, custom_type, custom_params={}):
+        """
+        Log a custom entry to the audit trail
+        
+        :param str custom_type value for customMsgType in audit trail item
+        :param dict custom_params value for customMsgParams in audit trail item
+        """
+        return self._perform_empty("POST",
+            "/admin/audit/custom/%s" % custom_type,
+            body = custom_params)
+
     ########################################################
     # Variables
     ########################################################
@@ -774,6 +785,18 @@ def create_personal_api_key(self, label):
         return self._perform_json("POST", "/auth/personal-api-keys",
                 params={"label": label})
 
+    ########################################################
+    # Licensing
+    ########################################################
+
+    def get_licensing_status(self):
+        """
+        Returns a dictionary with information about licensing status of this DSS instance
+
+        :rtype dict
+        """
+        return self._perform_json("GET", "/admin/licensing/status")
+
     ########################################################
     # Internal Request handling
     ########################################################

setup.py

@@ -2,7 +2,7 @@
 
 from setuptools import setup
 
-VERSION = "5.0.0"
+VERSION = "5.1.0"
 
 long_description = (open('README').read() +
     '\n\n' + open('HISTORY.txt').read())