Merge pull request plotly#348 from plotly/updated-offline-mode

Updated offline mode

Author: chriddyp

CHANGELOG.md

@@ -4,6 +4,20 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [1.9.0] - 2015-11-15
+- Previously, using plotly offline required a paid license.
+No more: `plotly.js` is now shipped inside this package to allow
+unlimited free use of plotly inside the ipython notebook environment.
+The `plotly.js` library that is included in this package is free,
+open source, and maintained independently on GitHub at
+[https://github.com/plotly/plotly.js](https://github.com/plotly/plotly.js).
+- The `plotly.js` bundle that is required for offline use is no longer downloaded
+and installed independently from this package: `plotly.offline.download_plotlyjs`
+is **deprecated**.
+- New versions of `plotly.js` will be tested and incorporated
+  into this package as new versioned pip releases;
+  `plotly.js` is not automatically kept in sync with this package.
+
 ## [1.8.12] - 2015-11-02
 - *Big data* warning mentions `plotly.graph_objs.Scattergl` as possible solution.
 

plotly/graph_reference/default-schema.json

@@ -8,40 +8,29 @@
 import json
 import os
 import uuid
-
-import requests
+import warnings
+from pkg_resources import resource_string
 
 from plotly import session, tools, utils
 from plotly.exceptions import PlotlyError
 
-PLOTLY_OFFLINE_DIRECTORY = plotlyjs_path = os.path.expanduser(
-    os.path.join(*'~/.plotly/plotlyjs'.split('/')))
-PLOTLY_OFFLINE_BUNDLE = os.path.join(PLOTLY_OFFLINE_DIRECTORY,
-                                     'plotly-ipython-offline-bundle.js')
-
 
 __PLOTLY_OFFLINE_INITIALIZED = False
 
 
 def download_plotlyjs(download_url):
-    if not os.path.exists(PLOTLY_OFFLINE_DIRECTORY):
-        os.makedirs(PLOTLY_OFFLINE_DIRECTORY)
-
-    res = requests.get(download_url)
-    res.raise_for_status()
+    warnings.warn('''
+        `download_plotlyjs` is deprecated and will be removed in the
+        next release. plotly.js is shipped with this module, it is no
+        longer necessary to download this bundle separately.
+    ''', DeprecationWarning)
+    pass
 
-    with open(PLOTLY_OFFLINE_BUNDLE, 'wb') as f:
-        f.write(res.content)
 
-    print('\n'.join([
-        'Success! Now start an IPython notebook and run the following ' +
-        'code to make your first offline graph:',
-        '',
-        'import plotly',
-        'plotly.offline.init_notebook_mode() '
-        '# run at the start of every ipython notebook',
-        'plotly.offline.iplot([{"x": [1, 2, 3], "y": [3, 1, 6]}])'
-    ]))
+def get_plotlyjs():
+    path = os.path.join('offline', 'plotly.min.js')
+    plotlyjs = resource_string('plotly', path).decode('utf-8')
+    return plotlyjs
 
 
 def init_notebook_mode():
@@ -55,24 +44,20 @@ def init_notebook_mode():
         raise ImportError('`iplot` can only run inside an IPython Notebook.')
     from IPython.display import HTML, display
 
-    if not os.path.exists(PLOTLY_OFFLINE_BUNDLE):
-        raise PlotlyError('Plotly Offline source file at {source_path} '
-                          'is not found.\n'
-                          'If you have a Plotly Offline license, then try '
-                          'running plotly.offline.download_plotlyjs(url) '
-                          'with a licensed download url.\n'
-                          "Don't have a Plotly Offline license? "
-                          'Contact [email protected] learn more about licensing.\n'
-                          'Questions? [email protected].'
-                          .format(source_path=PLOTLY_OFFLINE_BUNDLE))
-
     global __PLOTLY_OFFLINE_INITIALIZED
     __PLOTLY_OFFLINE_INITIALIZED = True
     display(HTML('<script type="text/javascript">' +
-                 open(PLOTLY_OFFLINE_BUNDLE).read() + '</script>'))
+                 # ipython's includes `require` as a global, which
+                 # conflicts with plotly.js. so, unrequire it.
+                 'require=requirejs=define=undefined;' +
+                 '</script>' +
+                 '<script type="text/javascript">' +
+                 get_plotlyjs() +
+                 '</script>'))
 
 
-def iplot(figure_or_data, show_link=True, link_text='Export to plot.ly'):
+def iplot(figure_or_data, show_link=True, link_text='Export to plot.ly',
+          validate=True):
     """
     Draw plotly graphs inside an IPython notebook without
     connecting to an external server.
@@ -90,6 +75,11 @@ def iplot(figure_or_data, show_link=True, link_text='Export to plot.ly'):
                                 of the chart that will export the chart to
                                 Plotly Cloud or Plotly Enterprise
     link_text (default='Export to plot.ly') -- the text of export link
+    validate (default=True) -- validate that all of the keys in the figure
+                               are valid? omit if your version of plotly.js
+                               has become outdated with your version of
+                               graph_reference.json or if you need to include
+                               extra, unnecessary keys in your figure.
 
     Example:
     ```
@@ -112,15 +102,10 @@ def iplot(figure_or_data, show_link=True, link_text='Export to plot.ly'):
         raise ImportError('`iplot` can only run inside an IPython Notebook.')
 
     from IPython.display import HTML, display
-    if isinstance(figure_or_data, dict):
-        data = figure_or_data['data']
-        layout = figure_or_data.get('layout', {})
-    else:
-        data = figure_or_data
-        layout = {}
+    figure = tools.return_figure_from_figure_or_data(figure_or_data, validate)
 
-    width = layout.get('width', '100%')
-    height = layout.get('height', 525)
+    width = figure.get('layout', {}).get('width', '100%')
+    height = figure.get('layout', {}).get('height', 525)
     try:
         float(width)
     except (ValueError, TypeError):
@@ -136,11 +121,13 @@ def iplot(figure_or_data, show_link=True, link_text='Export to plot.ly'):
         width = str(width) + 'px'
 
     plotdivid = uuid.uuid4()
-    jdata = json.dumps(data, cls=utils.PlotlyJSONEncoder)
-    jlayout = json.dumps(layout, cls=utils.PlotlyJSONEncoder)
+    jdata = json.dumps(figure.get('data', []), cls=utils.PlotlyJSONEncoder)
+    jlayout = json.dumps(figure.get('layout', {}), cls=utils.PlotlyJSONEncoder)
 
-    if show_link is False:
-        link_text = ''
+    config = {}
+    config['showLink'] = show_link
+    config['linkText'] = link_text
+    jconfig = json.dumps(config)
 
     plotly_platform_url = session.get_session_config().get('plotly_domain',
                                                            'https://plot.ly')
@@ -156,18 +143,17 @@ def iplot(figure_or_data, show_link=True, link_text='Export to plot.ly'):
         '<script type="text/javascript">'
         'window.PLOTLYENV=window.PLOTLYENV || {};'
         'window.PLOTLYENV.BASE_URL="' + plotly_platform_url + '";'
-        'Plotly.LINKTEXT = "' + link_text + '";'
         '</script>'
     ))
 
     script = '\n'.join([
-        'Plotly.plot("{id}", {data}, {layout}).then(function() {{',
+        'Plotly.plot("{id}", {data}, {layout}, {config}).then(function() {{',
         '    $(".{id}.loading").remove();',
         '}})'
     ]).format(id=plotdivid,
               data=jdata,
               layout=jlayout,
-              link_text=link_text)
+              config=jconfig)
 
     display(HTML(''
                  '<div class="{id} loading" style="color: rgb(50,50,50);">'

plotly/offline/offline.py

@@ -4,41 +4,21 @@
 """
 from __future__ import absolute_import
 
-import os
-from nose.plugins.attrib import attr
 from nose.tools import raises
 from unittest import TestCase
 
 import plotly
-from plotly.exceptions import PlotlyError
-
-dummy_js_url = ('https://gist.githubusercontent.com/chriddyp/'
-                'f40bd33d1eab6f0715dc/raw/'
-                '24cd2e4e62ceea79e6e790b3a2c94cda63510ede/'
-                'test.js')
 
 
 class PlotlyOfflineTestCase(TestCase):
-    def _remove_plotlyjs(self):
-        try:
-            os.remove(plotly.offline.offline.PLOTLY_OFFLINE_BUNDLE)
-        except OSError:
-            pass
-
-    def test_no_errors_are_raised_when_initializing_offline_mode(self):
-        self._remove_plotlyjs()
-        plotly.offline.download_plotlyjs(dummy_js_url)
-        plotly.offline.init_notebook_mode()
-        plotly.offline.iplot([{'x': [1, 2, 3]}])
+    def setUp(self):
+        plotly.offline.offline.__PLOTLY_OFFLINE_INITIALIZED = False
 
-    @attr('slow')
-    @raises(PlotlyError)
-    def test_calling_iplot_before_initializing_raises_an_error(self):
-        self._remove_plotlyjs()
-        plotly.offline.download_plotlyjs(dummy_js_url)
-        plotly.offline.iplot([{'x': [1, 2, 3]}])
+    @raises(plotly.exceptions.PlotlyError)
+    def test_iplot_doesnt_work_before_you_call_init_notebook_mode(self):
+        plotly.offline.iplot([{}])
 
-    @raises(PlotlyError)
-    def test_initializing_before_downloading_raises_an_error(self):
-        self._remove_plotlyjs()
+    def test_iplot_works_after_you_call_init_notebook_mode(self):
+        plotly.tools._ipython_imported = True
         plotly.offline.init_notebook_mode()
+        plotly.offline.iplot([{}])

plotly/offline/plotly.min.js

@@ -1 +1 @@
-__version__ = '1.8.12'
+__version__ = '1.9.0'

plotly/tests/test_core/test_offline/__init__.py

@@ -40,6 +40,6 @@ def readme():
                 'plotly/matplotlylib',
                 'plotly/matplotlylib/mplexporter',
                 'plotly/matplotlylib/mplexporter/renderers'],
-      package_data={'plotly': ['graph_reference/*.json', 'widgets/*.js']},
+      package_data={'plotly': ['graph_reference/*.json', 'widgets/*.js', 'offline/*.js']},
       install_requires=['requests', 'six', 'pytz'],
       zip_safe=False)