Merge pull request #22 from dataiku/feature/collaboration

public api for collaboration features

Author: spicquenot

dataikuapi/dss/dataset.py

@@ -3,6 +3,7 @@
 from ..utils import DataikuStreamedHttpUTF8CSVReader
 import json
 from .metrics import ComputedMetrics
+from .discussion import DSSObjectDiscussions
 
 class DSSDataset(object):
     """
@@ -234,3 +235,15 @@ def get_usages(self):
             a list of usages
         """
         return self.client._perform_json("GET", "/projects/%s/datasets/%s/usages" % (self.project_key, self.dataset_name))
+
+    ########################################################
+    # Discussions
+    ########################################################
+    def get_object_discussions(self):
+        """
+        Get a handle to manage discussions on the dataset
+
+        :returns: the handle to manage discussions
+        :rtype: :class:`dataikuapi.discussion.DSSObjectDiscussions`
+        """
+        return DSSObjectDiscussions(self.client, self.project_key, "DATASET", self.dataset_name)

dataikuapi/dss/discussion.py

@@ -0,0 +1,191 @@
+import json
+import sys
+
+if sys.version_info >= (3,0):
+  import urllib.parse
+  dku_quote_fn = urllib.parse.quote
+else:
+  import urllib
+  dku_quote_fn = urllib.quote
+
+class DSSObjectDiscussions(object):
+    """
+    A handle to manage discussions on a DSS object
+    """
+    def __init__(self, client, project_key, object_type, object_id):
+        """Do not call directly, use :meth:`dataikuapi.dssclient.DSSClient.get_object_discussions` or on any commentable DSS object"""
+        self.client = client
+        self.project_key = project_key
+        self.object_type = object_type
+        self.object_id = object_id
+        # encode in UTF-8 if its python2 and unicode
+        if sys.version_info < (3,0) and isinstance(self.object_id, unicode):
+            self.object_id = self.object_id.encode('utf-8')
+
+    def list_discussions(self):
+        """
+        Get the list of discussions on the object
+
+        :returns: list of discussions on the object
+        :rtype: list of :class:`dataikuapi.dss.discussion.DSSDiscussion`
+        """
+        data = self.client._perform_json("GET", "/projects/%s/discussions/%s/%s/" % (self.project_key, self.object_type, self.object_id))
+        return [DSSDiscussion(self.client, self.project_key, self.object_type, self.object_id, discu_data['id'], discu_data, False) for discu_data in data]
+
+    def create_discussion(self, topic, message):
+        """
+        Create a new discussion
+
+        :param str topic: the discussion topic
+        :param str message: the markdown formatted first message
+        :returns: the newly created discussion
+        :rtype: :class:`dataikuapi.dss.discussion.DSSDiscussion`
+        """
+        creation_data = {
+            "topic" : topic,
+            "reply" : message
+        }
+        discu_data = self.client._perform_json("POST", "/projects/%s/discussions/%s/%s/" % (self.project_key, self.object_type, self.object_id), body=creation_data)
+        return DSSDiscussion(self.client, self.project_key, self.object_type, self.object_id, discu_data['id'], discu_data, True)
+
+    def get_discussion(self, discussion_id):
+        """
+        Get a specific discussion
+
+        :param str discussion_id: the discussion ID
+        :returns: the discussion
+        :rtype: :class:`dataikuapi.dss.discussion.DSSDiscussion`
+        """
+        discu_data = self.client._perform_json("GET", "/projects/%s/discussions/%s/%s/%s" % (self.project_key, self.object_type, self.object_id, discussion_id))
+        return DSSDiscussion(self.client, self.project_key, self.object_type, self.object_id, discussion_id, discu_data, True)
+
+class DSSDiscussion(object):
+    """Do not call directly, use :meth:`dataikuapi.dss.discussion.DSSObjectDiscussions.get_discussion`"""
+    def __init__(self, client, project_key, object_type, object_id, discussion_id, discussion_data, discussion_data_has_replies):
+        """
+        :param DSSClient client: an api client to connect to the DSS backend
+        :param str project_key: identifier of the project to access
+        :param str object_type: DSS object type
+        :param str object_id: DSS object ID
+        :param str discussion_id: identified of the discussion
+        :param dict discussion_data: the discussion data
+        :param bool discussion_data_has_replies: a flag that indicates if the replies has been loaded
+        """
+        self.client = client
+        self.project_key = project_key
+        self.object_type = object_type
+        self.object_id = object_id
+        self.discussion_id = discussion_id
+        self.discussion_data = discussion_data
+        self.discussion_data_has_replies = discussion_data_has_replies
+
+    def _get_with_replies(self):
+        """
+        Reload the discussion data from the backend including the replies
+        """
+        self.discussion_data = self.client._perform_json("GET", "/projects/%s/discussions/%s/%s/%s" % (self.project_key, self.object_type, self.object_id, self.discussion_id))
+        self.discussion_data_has_replies = True
+
+    def get_metadata(self):
+        """
+        Get the discussion metadata
+
+        :returns: the discussion metadata
+        :rtype: dict
+        """
+        metadata = dict(self.discussion_data)
+        if "replies" in metadata:
+            del metadata["replies"]
+        return metadata
+
+    def set_metadata(self, discussion_metadata):
+        """
+        Update the discussion metadata
+
+        :param dict discussion_metadata: the discussion metadata
+        """
+        if not self.discussion_data_has_replies:
+            self._get_with_replies()
+
+        edited_metadata = dict(discussion_metadata)
+        edited_metadata["replies"] = self.discussion_data["replies"]
+
+        self.discussion_data = self.client._perform_json("PUT", "/projects/%s/discussions/%s/%s/%s" % (self.project_key, self.object_type, self.object_id, self.discussion_id), body=edited_metadata)
+        self.discussion_data_has_replies = True
+
+    def get_replies(self):
+        """
+        Get the list of replies in this discussion
+
+        :returns: a list of replies
+        :rtype: list of :class:`dataikuapi.dss.discussion.DSSDiscussionReply`
+        """
+        if not self.discussion_data_has_replies:
+            self._get_with_replies()
+
+        return [DSSDiscussionReply(reply_data) for reply_data in self.discussion_data["replies"]]
+
+    def add_reply(self, text):
+        """
+        Add a reply to a discussion
+
+        :param str text: the markdown formatted text to reply
+        """
+        reply_data = {
+            "reply": text
+        }
+        self.discussion_data = self.client._perform_json("POST", "/projects/%s/discussions/%s/%s/%s/replies/" % (self.project_key, self.object_type, self.object_id, self.discussion_id), body=reply_data)
+        self.discussion_data_has_replies = True
+
+class DSSDiscussionReply(object):
+    """
+    A read-only handle to access a discussion reply
+    """
+    def __init__(self, reply_data):
+        """Do not call directly, use :meth:`dataikuapi.dss.discussion.DSSDiscussion.get_replies`"""
+        self.reply_data = reply_data
+
+    def get_raw_data(self):
+        """
+        Get the reply raw data
+
+        :returns: the reply data
+        :rtype: dict
+        """
+        return self.reply_data
+
+    def get_text(self):
+        """
+        Get the reply text
+
+        :returns: the reply text
+        :rtype: str
+        """
+        return self.reply_data["text"]
+
+    def get_author(self):
+        """
+        Get the reply author
+
+        :returns: the author ID
+        :rtype: str
+        """
+        return self.reply_data["author"]
+
+    def get_timestamp(self):
+        """
+        Get the reply timestamp
+
+        :returns: the reply timestamp
+        :rtype: long
+        """
+        return self.reply_data["time"]
+
+    def get_edited_timestamp(self):
+        """
+        Get the last edition timestamp
+
+        :returns: the last edition timestamp
+        :rtype: long
+        """
+        return self.reply_data["editedOn"]

dataikuapi/dss/managedfolder.py

@@ -3,6 +3,7 @@
 from ..utils import DataikuStreamedHttpUTF8CSVReader
 import json
 from .metrics import ComputedMetrics
+from .discussion import DSSObjectDiscussions
 
 class DSSManagedFolder(object):
     """
@@ -161,4 +162,14 @@ def get_usages(self):
         """
         return self.client._perform_json("GET", "/projects/%s/managedfolders/%s/usages" % (self.project_key, self.odb_id))
 
+    ########################################################
+    # Discussions
+    ########################################################
+    def get_object_discussions(self):
+        """
+        Get a handle to manage discussions on the managed folder
 
+        :returns: the handle to manage discussions
+        :rtype: :class:`dataikuapi.discussion.DSSObjectDiscussions`
+        """
+        return DSSObjectDiscussions(self.client, self.project_key, "MANAGED_FOLDER", self.odb_id)

dataikuapi/dss/notebook.py

@@ -1,3 +1,5 @@
+from .discussion import DSSObjectDiscussions
+
 class DSSNotebook(object):
     """
     A Python/R/Scala notebook on the DSS instance
@@ -45,3 +47,15 @@ def get_sessions(self):
         if state.get('activeSessions', None) is None:
             raise Exception("Notebook isn't running")
         return state['activeSessions']
+
+    ########################################################
+    # Discussions
+    ########################################################
+    def get_object_discussions(self):
+        """
+        Get a handle to manage discussions on the notebook
+
+        :returns: the handle to manage discussions
+        :rtype: :class:`dataikuapi.discussion.DSSObjectDiscussions`
+        """
+        return DSSObjectDiscussions(self.client, self.project_key, "JUPYTER_NOTEBOOK", self.notebook_name)

dataikuapi/dss/project.py

@@ -11,6 +11,8 @@
 from .future import DSSFuture
 from .notebook import DSSNotebook
 from .macro import DSSMacro
+from .wiki import DSSWiki
+from .discussion import DSSObjectDiscussions
 from .ml import DSSMLTask
 from .analysis import DSSAnalysis
 from dataikuapi.utils import DataikuException
@@ -745,6 +747,29 @@ def get_macro(self, runnable_type):
         """
         return DSSMacro(self.client, self.project_key, runnable_type)
 
+    ########################################################
+    # Wiki
+    ########################################################
+    def get_wiki(self):
+        """
+        Get the wiki
+
+        :returns: the wiki associated to the project
+        :rtype: :class:`dataikuapi.dss.wiki.DSSWiki`
+        """
+        return DSSWiki(self.client, self.project_key)
+
+    ########################################################
+    # Discussions
+    ########################################################
+    def get_object_discussions(self):
+        """
+        Get a handle to manage discussions on the project
+
+        :returns: the handle to manage discussions
+        :rtype: :class:`dataikuapi.discussion.DSSObjectDiscussions`
+        """
+        return DSSObjectDiscussions(self.client, self.project_key, "PROJECT", self.project_key)
 
 class DSSProjectSettings(object):
     """Settings of a DSS project"""

dataikuapi/dss/recipe.py

@@ -1,4 +1,5 @@
 from ..utils import DataikuException
+from .discussion import DSSObjectDiscussions
 import json
 
 class DSSRecipe(object):
@@ -76,6 +77,18 @@ def set_metadata(self, metadata):
                 "PUT", "/projects/%s/recipes/%s/metadata" % (self.project_key, self.recipe_name),
                 body=metadata)
 
+    ########################################################
+    # Discussions
+    ########################################################
+    def get_object_discussions(self):
+        """
+        Get a handle to manage discussions on the recipe
+
+        :returns: the handle to manage discussions
+        :rtype: :class:`dataikuapi.discussion.DSSObjectDiscussions`
+        """
+        return DSSObjectDiscussions(self.client, self.project_key, "RECIPE", self.recipe_name)
+
 
 class DSSRecipeDefinitionAndPayload(object):
     """

dataikuapi/dss/savedmodel.py

@@ -4,6 +4,7 @@
 import json
 from .ml import DSSTrainedPredictionModelDetails, DSSTrainedClusteringModelDetails
 from .metrics import ComputedMetrics
+from .discussion import DSSObjectDiscussions
 
 class DSSSavedModel(object):
     """
@@ -97,3 +98,14 @@ def get_usages(self):
         return self.client._perform_json("GET", "/projects/%s/savedmodels/%s/usages" % (self.project_key, self.sm_id))
 
 
+    ########################################################
+    # Discussions
+    ########################################################
+    def get_object_discussions(self):
+        """
+        Get a handle to manage discussions on the saved model
+
+        :returns: the handle to manage discussions
+        :rtype: :class:`dataikuapi.discussion.DSSObjectDiscussions`
+        """
+        return DSSObjectDiscussions(self.client, self.project_key, "SAVED_MODEL", self.sm_id)

dataikuapi/dss/scenario.py

@@ -1,6 +1,7 @@
 from datetime import datetime
 import time
 from dataikuapi.utils import DataikuException
+from .discussion import DSSObjectDiscussions
 
 
 class DSSScenario(object):
@@ -155,6 +156,18 @@ def get_average_duration(self, limit=3):
             return None
         return sum([run.get_duration() for run in last_runs]) / len(last_runs)
 
+    ########################################################
+    # Discussions
+    ########################################################
+    def get_object_discussions(self):
+        """
+        Get a handle to manage discussions on the scenario
+
+        :returns: the handle to manage discussions
+        :rtype: :class:`dataikuapi.discussion.DSSObjectDiscussions`
+        """
+        return DSSObjectDiscussions(self.client, self.project_key, "SCENARIO", self.id)
+
 
 class DSSScenarioRun(object):
     """