Merge pull request plotly#705 from plotly/ver-bump

Kully · web-flow · commit c6605060808e · 2017-03-07T01:46:03.000-05:00
update-CHANGELOG and ver # for dashboards
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,8 +3,10 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
+
+## [2.0.3] - 2017-03-06
 ## Added
-- dashboards can now be created using the API and uploaded to Plotly. Use `import plotly.dashboard_objs` to be create a dashboard a `Dashboard` object. You can learn more about `Dashboard` objects by running `help(plotly.dashboard_objs.Dashboard)` and `help(plotly.plotly.plotly.dashboard_ops)` for uploading and retrieving dashboards from the cloud.
+- Dashboards can now be created using the API and uploaded to Plotly. Use `import plotly.dashboard_objs` to create a `Dashboard` object. You can learn more about `Dashboard` objects by running `help(plotly.dashboard_objs)` and `help(plotly.plotly.plotly.dashboard_ops)` for uploading and retrieving dashboards from the cloud.
 
 
 ## [2.0.2] - 2017-02-20
diff --git a/plotly/dashboard_objs/__init__.py b/plotly/dashboard_objs/__init__.py
@@ -1 +1,72 @@
+"""
+dashboard_objs
+==========
+
+A module for creating and manipulating dashboard content. You can create
+a Dashboard object, insert boxes, swap boxes, remove a box and get an HTML
+preview of the Dashboard.
+
+The current workflow for making and manipulating dashboard follows:
+1) Create a Dashboard
+2) Modify the Dashboard (insert, swap, remove, etc)
+3) Preview the Dashboard (run `.get_preview()`)
+4) Repeat steps 2) and 3) as long as desired
+
+The basic box object that your insert into a dashboard is just a `dict`.
+The minimal dict for a box is:
+
+```
+{
+    'type': 'box',
+    'boxType': 'plot'
+}
+```
+
+where 'fileId' can be set to the 'username:#' of your plot. The other
+parameters
+a box takes are `shareKey` (default is None) and `title` (default is '').
+
+You will need to use the `.get_preview()` method quite regularly as this will
+return an HTML representation of the dashboard in which the boxes in the HTML
+are labelled with on-the-fly-generated numbers which change after each
+modification to the dashboard.
+
+Example: Create a simple Dashboard object
+```
+import plotly.dashboard_objs as dashboard
+
+box_1 = {
+    'type': 'box',
+    'boxType': 'plot',
+    'fileId': 'username:some#',
+    'title': 'box 1'
+}
+
+box_2 = {
+    'type': 'box',
+    'boxType': 'plot',
+    'fileId': 'username:some#',
+    'title': 'box 2'
+}
+
+box_3 = {
+    'type': 'box',
+    'boxType': 'plot',
+    'fileId': 'username:some#',
+    'title': 'box 3'
+}
+
+my_dboard = dashboard.Dashboard()
+my_dboard.insert(box_1)
+# my_dboard.get_preview()
+my_dboard.insert(box_2, 'above', 1)
+# my_dboard.get_preview()
+my_dboard.insert(box_3, 'left', 2)
+# my_dboard.get_preview()
+my_dboard.swap(1, 2)
+# my_dboard.get_preview()
+my_dboard.remove(1)
+# my_dboard.get_preview()
+```
+"""
 from . dashboard_objs import Dashboard
diff --git a/plotly/dashboard_objs/dashboard_objs.py b/plotly/dashboard_objs/dashboard_objs.py
@@ -5,68 +5,6 @@
 A module for creating and manipulating dashboard content. You can create
 a Dashboard object, insert boxes, swap boxes, remove a box and get an HTML
 preview of the Dashboard.
-
-The current workflow for making and manipulating dashboard follows:
-1) Create a Dashboard
-2) Modify the Dashboard (insert, swap, remove, etc)
-3) Preview the Dashboard (run `.get_preview()`)
-4) Repeat steps 2) and 3) as long as desired
-
-The basic box object that your insert into a dashboard is just a `dict`.
-The minimal dict for a box is:
-
-```
-{
-    'type': 'box',
-    'boxType': 'plot'
-}
-```
-
-where 'fileId' can be set to the 'username:#' of your plot. The other
-parameters
-a box takes are `shareKey` (default is None) and `title` (default is '').
-
-You will need to use the `.get_preview()` method quite regularly as this will
-return an HTML representation of the dashboard in which the boxes in the HTML
-are labelled with on-the-fly-generated numbers which change after each
-modification to the dashboard.
-
-Example: Create a simple Dashboard object
-```
-import plotly.dashboard_objs as dashboard
-
-box_1 = {
-    'type': 'box',
-    'boxType': 'plot',
-    'fileId': 'username:some#',
-    'title': 'box 1'
-}
-
-box_2 = {
-    'type': 'box',
-    'boxType': 'plot',
-    'fileId': 'username:some#',
-    'title': 'box 2'
-}
-
-box_3 = {
-    'type': 'box',
-    'boxType': 'plot',
-    'fileId': 'username:some#',
-    'title': 'box 3'
-}
-
-my_dboard = dashboard.Dashboard()
-my_dboard.insert(box_1)
-# my_dboard.get_preview()
-my_dboard.insert(box_2, 'above', 1)
-# my_dboard.get_preview()
-my_dboard.insert(box_3, 'left', 2)
-# my_dboard.get_preview()
-my_dboard.swap(1, 2)
-# my_dboard.get_preview()
-my_dboard.remove(1)
-# my_dboard.get_preview()
 ```
 """
 
@@ -384,6 +322,9 @@ def get_preview(self):
             pprint.pprint(self)
             return
 
+        elif self['layout'] is None:
+            return IPython.display.HTML(dashboard_html)
+
         x = 0
         y = 0
         box_w = MASTER_WIDTH
@@ -577,7 +518,7 @@ def remove(self, box_id):
             raise exceptions.PlotlyError(ID_NOT_VALID_MESSAGE)
 
         path = box_ids_to_path[box_id]
-        if path != ['first']:
+        if path != ('first',):
             container_for_box_id = self._path_to_box(path[:-1])
             if path[-1] == 'first':
                 adjacent_path = 'second'
@@ -587,7 +528,7 @@ def remove(self, box_id):
 
             self._insert(adjacent_box, path[:-1])
         else:
-            self['layout'] = _empty_box()
+            self['layout'] = None
 
         self._set_container_sizes()
 
diff --git a/plotly/version.py b/plotly/version.py
@@ -1 +1 @@
-__version__ = '2.0.2'
+__version__ = '2.0.3'

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = '2.0.2'`
	`1`	`+__version__ = '2.0.3'`