fix issue #59 | improve docs styling | increase waiting time for unittest mb setup

Author: vvaezian

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 3.4.5
+### Changed
+- Fix [#59](https://github.com/vvaezian/metabase_api_python/issues/59)
+- Improve docs styling
+
 ## 3.4.4
 ### Changed
 - Make sure the provided API key is correct.

metabase_api/copy_methods.py

@@ -7,16 +7,17 @@ def copy_card(self, source_card_name=None, source_card_id=None,
     """
     Copy the card with the given name/id to the given destination collection. 
 
-    Keyword arguments:
-    source_card_name -- name of the card to copy (default None) 
-    source_card_id -- id of the card to copy (default None) 
-    source_collection_name -- name of the collection the source card is located in (default None) 
-    source_collection_id -- id of the collection the source card is located in (default None) 
-    destination_card_name -- name used for the card in destination (default None).
+    Parameters
+    ----------
+    source_card_name : name of the card to copy (default None) 
+    source_card_id : id of the card to copy (default None) 
+    source_collection_name : name of the collection the source card is located in (default None) 
+    source_collection_id : id of the collection the source card is located in (default None) 
+    destination_card_name : name used for the card in destination (default None).
                                                         If None, it will use the name of the source card + postfix.
-    destination_collection_name -- name of the collection to copy the card to (default None) 
-    destination_collection_id -- id of the collection to copy the card to (default None) 
-    postfix -- if destination_card_name is None, adds this string to the end of source_card_name 
+    destination_collection_name : name of the collection to copy the card to (default None) 
+    destination_collection_id : id of the collection to copy the card to (default None) 
+    postfix : if destination_card_name is None, adds this string to the end of source_card_name 
                             to make destination_card_name
     """
     ### Making sure we have the data that we need 
@@ -66,16 +67,17 @@ def copy_pulse(self, source_pulse_name=None, source_pulse_id=None,
     """
     Copy the pulse with the given name/id to the given destination collection. 
 
-    Keyword arguments:
-    source_pulse_name -- name of the pulse to copy (default None) 
-    source_pulse_id -- id of the pulse to copy (default None) 
-    source_collection_name -- name of the collection the source card is located in (default None) 
-    source_collection_id -- id of the collection the source card is located in (default None) 
-    destination_pulse_name -- name used for the pulse in destination (default None).
+    Parameters
+    ----------
+    source_pulse_name : name of the pulse to copy (default None) 
+    source_pulse_id : id of the pulse to copy (default None) 
+    source_collection_name : name of the collection the source card is located in (default None) 
+    source_collection_id : id of the collection the source card is located in (default None) 
+    destination_pulse_name : name used for the pulse in destination (default None).
                                                         If None, it will use the name of the source pulse + postfix.
-    destination_collection_name -- name of the collection to copy the pulse to (default None) 
-    destination_collection_id -- id of the collection to copy the pulse to (default None) 
-    postfix -- if destination_pulse_name is None, adds this string to the end of source_pulse_name 
+    destination_collection_name : name of the collection to copy the pulse to (default None) 
+    destination_collection_id : id of the collection to copy the pulse to (default None) 
+    postfix : if destination_pulse_name is None, adds this string to the end of source_pulse_name 
                             to make destination_pulse_name
     """
     ### Making sure we have the data that we need 
@@ -115,24 +117,23 @@ def copy_dashboard(self, source_dashboard_name=None, source_dashboard_id=None,
                     source_collection_name=None, source_collection_id=None,
                     destination_dashboard_name=None, 
                     destination_collection_name=None, destination_collection_id=None,
-                    deepcopy=False, postfix=''):
+                    deepcopy=False, postfix='', collection_position=1, description=''):
     """
     Copy the dashboard with the given name/id to the given destination collection. 
 
-    Keyword arguments:
-    source_dashboard_name -- name of the dashboard to copy (default None) 
-    source_dashboard_id -- id of the dashboard to copy (default None) 
-    source_collection_name -- name of the collection the source dashboard is located in (default None) 
-    source_collection_id -- id of the collection the source dashboard is located in (default None) 
-    destination_dashboard_name -- name used for the dashboard in destination (default None).
-                                                                If None, it will use the name of the source dashboard + postfix.
-    destination_collection_name -- name of the collection to copy the dashboard to (default None) 
-    destination_collection_id -- id of the collection to copy the dashboard to (default None) 
-    deepcopy -- whether to duplicate the cards inside the dashboard (default False).
-                            If True, puts the duplicated cards in a collection called "[dashboard_name]'s cards" 
-                            in the same path as the duplicated dashboard.
-    postfix -- if destination_dashboard_name is None, adds this string to the end of source_dashboard_name 
-                            to make destination_dashboard_name
+    Parameters
+    ----------
+    source_dashboard_name : name of the dashboard to copy (default None) 
+    source_dashboard_id : id of the dashboard to copy (default None) 
+    source_collection_name : name of the collection the source dashboard is located in (default None) 
+    source_collection_id : id of the collection the source dashboard is located in (default None) 
+    destination_dashboard_name : name used for the dashboard in destination (default None). 
+        If None, it will use the name of the source dashboard + postfix. 
+    destination_collection_name : name of the collection to copy the dashboard to (default None) 
+    destination_collection_id : id of the collection to copy the dashboard to (default None) 
+    deepcopy : whether to duplicate the cards inside the dashboard (default False). 
+    postfix : if destination_dashboard_name is None, adds this string to the end of source_dashboard_name 
+        to make destination_dashboard_name 
     """
     ### making sure we have the data that we need 
     if not source_dashboard_id:
@@ -154,52 +155,16 @@ def copy_dashboard(self, source_dashboard_name=None, source_dashboard_id=None,
             source_dashboard_name = self.get_item_name(item_type='dashboard', item_id=source_dashboard_id)
         destination_dashboard_name = source_dashboard_name + postfix
 
-    ### shallow-copy
-    shallow_copy_json = {'collection_id':destination_collection_id, 'name':destination_dashboard_name}
-    res = self.post('/api/dashboard/{}/copy'.format(source_dashboard_id), json=shallow_copy_json)
+    parameters = {
+        'collection_id':destination_collection_id, 
+        'name':destination_dashboard_name, 
+        'is_deep_copy':deepcopy,
+        'collection_position': collection_position,
+        'description': description
+    }
+    res = self.post('/api/dashboard/{}/copy'.format(source_dashboard_id), json=parameters)
     dup_dashboard_id = res['id']
 
-    ### deepcopy
-    if deepcopy:
-        # get the source dashboard info
-        source_dashboard = self.get('/api/dashboard/{}'.format(source_dashboard_id))
-
-        # create an empty collection to copy the cards into it
-        res = self.post('/api/collection/', 
-                        json={'name':destination_dashboard_name + "'s cards", 
-                                'color':'#509EE3', 
-                                'parent_id':destination_collection_id})
-        cards_collection_id = res['id']
-
-        # duplicate cards and put them in the created collection and make a card_id mapping
-        source_dashboard_card_IDs = [ i['card_id'] for i in source_dashboard['dashcards'] if i['card_id'] is not None ]
-        card_id_mapping = {}
-        for card_id in source_dashboard_card_IDs:
-            dup_card_id = self.copy_card(source_card_id=card_id, destination_collection_id=cards_collection_id)
-            card_id_mapping[card_id] = dup_card_id
-
-        # replace cards in the duplicated dashboard with duplicated cards
-        dup_dashboard = self.get('/api/dashboard/{}'.format(dup_dashboard_id))
-        for card in dup_dashboard['dashcards']:
-
-            # ignore text boxes. These get copied in the shallow-copy stage.
-            if card['card_id'] is None:
-                continue
-
-            # prepare a json to be used for replacing the cards in the duplicated dashboard
-            new_card_id = card_id_mapping[card['card_id']]
-            card_json = {}
-            card_json['cardId'] = new_card_id
-            for prop in ['visualization_settings', 'col', 'row', 'size_x', 'size_y', 'series', 'parameter_mappings']:
-                card_json[prop] = card[prop]
-            for item in card_json['parameter_mappings']:
-                item['card_id'] = new_card_id
-            # remove the card from the duplicated dashboard
-            dash_card_id = card['id'] # This is id of the card in the dashboard (different from id of the card itself)
-            self.delete('/api/dashboard/{}/cards'.format(dup_dashboard_id), params={'dashcardId':dash_card_id})
-            # add the new card to the duplicated dashboard
-            self.post('/api/dashboard/{}/cards'.format(dup_dashboard_id), json=card_json)
-
     return dup_dashboard_id
 
 
@@ -211,22 +176,23 @@ def copy_collection(self, source_collection_name=None, source_collection_id=None
     """
     Copy the collection with the given name/id into the given destination parent collection. 
 
-    Keyword arguments:
-    source_collection_name -- name of the collection to copy (default None) 
-    source_collection_id -- id of the collection to copy (default None) 
-    destination_collection_name -- the name to be used for the collection in the destination (default None).
+    Parameters
+    ----------
+    source_collection_name : name of the collection to copy (default None) 
+    source_collection_id : id of the collection to copy (default None) 
+    destination_collection_name : the name to be used for the collection in the destination (default None).
                                                                     If None, it will use the name of the source collection + postfix.
-    destination_parent_collection_name -- name of the destination parent collection (default None). 
+    destination_parent_collection_name : name of the destination parent collection (default None). 
                                                                                 This is the collection that would have the copied collection as a child.
                                                                                 use 'Root' for the root collection.
-    destination_parent_collection_id -- id of the destination parent collection (default None).
+    destination_parent_collection_id : id of the destination parent collection (default None).
                                                                             This is the collection that would have the copied collection as a child.
-    deepcopy_dashboards -- whether to duplicate the cards inside the dashboards (default False). 
+    deepcopy_dashboards : whether to duplicate the cards inside the dashboards (default False). 
                                                     If True, puts the duplicated cards in a collection called "[dashboard_name]'s duplicated cards" 
                                                     in the same path as the duplicated dashboard.
-    postfix -- if destination_collection_name is None, adds this string to the end of source_collection_name to make destination_collection_name.
-    child_items_postfix -- this string is added to the end of the child items' names, when saving them in the destination (default '').
-    verbose -- prints extra information (default False) 
+    postfix : if destination_collection_name is None, adds this string to the end of source_collection_name to make destination_collection_name.
+    child_items_postfix : this string is added to the end of the child items' names, when saving them in the destination (default '').
+    verbose : prints extra information (default False) 
     """
     ### making sure we have the data that we need 
     if not source_collection_id:

metabase_api/create_methods.py

@@ -6,21 +6,22 @@ def create_card(self, card_name=None, collection_name=None, collection_id=None,
     Create a card using the given arguments utilizing the endpoint 'POST /api/card/'. 
     If collection is not given, the root collection is used.
 
-    Keyword arguments:
-    card_name -- the name used to create the card (default None) 
-    collection_name -- name of the collection to place the card (default None).
-    collection_id -- id of the collection to place the card (default None) 
-    db_name -- name of the db that is used as the source of data (default None)    
-    db_id -- id of the db used as the source of data (default None) 
-    table_name -- name of the table used as the source of data (default None)
-    table_id -- id of the table used as the source of data (default None) 
-    column_order -- order for showing columns. Accepted values are 'alphabetical', 'db_table_order' (default) 
+    Parameters
+    ----------
+    card_name : the name used to create the card (default None) 
+    collection_name : name of the collection to place the card (default None).
+    collection_id : id of the collection to place the card (default None) 
+    db_name : name of the db that is used as the source of data (default None)    
+    db_id : id of the db used as the source of data (default None) 
+    table_name : name of the table used as the source of data (default None)
+    table_id : id of the table used as the source of data (default None) 
+    column_order : order for showing columns. Accepted values are 'alphabetical', 'db_table_order' (default) 
                                     or a list of column names
-    custom_json -- key-value pairs that can provide some or all the data needed for creating the card (default None).
+    custom_json : key-value pairs that can provide some or all the data needed for creating the card (default None).
                                     If you are providing only this argument, the keys 'name', 'dataset_query' and 'display' are required
                                     (https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#post-apicard).
-    verbose -- whether to print extra information (default False)
-    return_card --    whather to return the created card info (default False)
+    verbose : whether to print extra information (default False)
+    return_card :    whather to return the created card info (default False)
     """
     if custom_json:
         assert type(custom_json) == dict
@@ -178,11 +179,12 @@ def create_collection(self, collection_name, parent_collection_id=None, parent_c
     """
     Create an empty collection, in the given location, utilizing the endpoint 'POST /api/collection/'. 
 
-    Keyword arguments:
-    collection_name -- the name used for the created collection.
-    parent_collection_id -- id of the collection where the created collection resides in.
-    parent_collection_name -- name of the collection where the created collection resides in (use 'Root' for the root collection).
-    return_results -- whether to return the info of the created collection.
+    Parameters
+    ----------
+    collection_name : the name used for the created collection.
+    parent_collection_id : id of the collection where the created collection resides in.
+    parent_collection_name : name of the collection where the created collection resides in (use 'Root' for the root collection).
+    return_results : whether to return the info of the created collection.
     """
     # Making sure we have the data we need
     if not parent_collection_id:
@@ -204,16 +206,17 @@ def create_segment(self, segment_name, column_name, column_values, segment_descr
     """
     Create a segment using the given arguments utilizing the endpoint 'POST /api/segment/'. 
 
-    Keyword arguments:
-    segment_name -- the name used for the created segment.
-    column_name -- name of the column used for filtering.
-    column_values -- list of values for filtering in the given column.
-    segment_description -- description of the segment (default '') 
-    db_name -- name of the db that is used as the source of data (default None)    
-    db_id -- id of the db used as the source of data (default None) 
-    table_name -- name of the table used for creating the segmnet on it (default None)    
-    table_id -- id of the table used for creating the segmnet on it (default None)    
-    return_segment --    whather to return the created segment info (default False)
+    Parameters
+    ----------
+    segment_name : the name used for the created segment.
+    column_name : name of the column used for filtering.
+    column_values : list of values for filtering in the given column.
+    segment_description : description of the segment (default '') 
+    db_name : name of the db that is used as the source of data (default None)    
+    db_id : id of the db used as the source of data (default None) 
+    table_name : name of the table used for creating the segmnet on it (default None)    
+    table_id : id of the table used for creating the segmnet on it (default None)    
+    return_segment :    whather to return the created segment info (default False)
     """
     # Making sure we have the data needed
     if not table_name and not table_id: