Merge remote-tracking branch 'origin/master' into ipyplotly_integration

jonmmease · jonmmease · commit 600b7b6cbb92 · 2018-06-11T08:18:21.000-04:00
# Conflicts:
#	plotly/graph_objs/graph_objs.py
#	plotly/package_data/plotly.min.js
#	plotly/utils.py
#	plotly/version.py
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,9 +2,22 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [2.5.2] - UNRELEASED
+## [2.7.1] - [UNRELEASED]
 ### Updated
-- error message for `plotly.figure_factory.create_choropleth` is more helpful for Windows users on installing `geopandas` and dependencies including `shapely`.
+- error message for `plotly.figure_factory.create_choropleth` is now helpful to Anaconda users who do not have the correct modules installed for the County Choropleth figure factory.
+
+## [2.7.0] - 2018-05-23
+### Updated
+- Updated `plotly.min.js` to version 1.38.0.
+  - New features include a `3D cone` trace to visualize vector fields.
+  - See [the plotly.js CHANGELOG](https://github.com/plotly/plotly.js/blob/master/CHANGELOG.md#1380----2018-05-23) for additional information regarding the updates.
+
+## [2.6.0] - 2018-05-09
+### Updated
+- Updated `plotly.min.js` to version 1.37.1.
+  - New features include a `splom` (scatter plot matrix) trace type.
+  - See [the plotly.js CHANGELOG](https://github.com/plotly/plotly.js/blob/master/CHANGELOG.md#1371----2018-05-02) for additional information regarding the updates.
+- Error message for `plotly.figure_factory.create_choropleth` is more helpful for Windows users on installing `geopandas` and dependencies including `shapely`.
 
 ## [2.5.1] - 2018-03-26
 ### Fixed
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
 # plotly.py
 
 > 📢  Announcement!  
-> Registration is open for a 2 day, Dash master class in Boston, April 14-15.  
-> [Register online here](https://plotcon.plot.ly/tickets/) 🎚📈⚾️ 
+> Registration is open for a 2 day, Dash master class in Washington DC, June 9-10.  
+> [Register online here](https://plotcon.plot.ly/tickets/) 🎚📈🏛
 
 ***
 
diff --git a/plotly/figure_factory/_county_choropleth.py b/plotly/figure_factory/_county_choropleth.py
@@ -565,12 +565,20 @@ def create_choropleth(fips, values, scope=['usa'], binning_endpoints=None,
             "geopandas, pyshp and shapely must be installed for this figure "
             "factory.\n\nRun the following commands to install the correct "
             "versions of the following modules:\n\n"
-            "`pip install geopandas==0.3.0`\n"
-            "`pip install pyshp==1.2.10`\n"
-            "`pip install shapely==1.6.3`\n\n"
+            "```\n"
+            "pip install geopandas==0.3.0\n"
+            "pip install pyshp==1.2.10\n"
+            "pip install shapely==1.6.3\n"
+            "```\n"
             "If you are using Windows, follow this post to properly "
             "install geopandas and dependencies:"
-            "http://geoffboeing.com/2014/09/using-geopandas-windows/"
+            "http://geoffboeing.com/2014/09/using-geopandas-windows/\n\n"
+            "If you are using Anaconda, do not use PIP to install the "
+            "packages above. Instead use conda to install them:\n\n"
+            "```\n"
+            "conda install plotly\n"
+            "conda install geopandas\n"
+            "```"
         )
 
     df, df_state = _create_us_counties_df(st_to_state_name_dict,
diff --git a/plotly/package_data/default-schema.json b/plotly/package_data/default-schema.json
diff --git a/plotly/package_data/plotly.min.js b/plotly/package_data/plotly.min.js
diff --git a/plotly/tests/test_core/test_tools/test_file_tools.py b/plotly/tests/test_core/test_tools/test_file_tools.py
@@ -1,6 +1,8 @@
 from plotly import tools, session
 from plotly.tests.utils import PlotlyTestCase
 
+import warnings
+
 
 class FileToolsTest(PlotlyTestCase):
 
@@ -43,14 +45,37 @@ def test_set_config_file_two_entries(self):
         self.assertEqual(config['plotly_streaming_domain'], streaming_domain)
         tools.reset_config_file()
 
-
     def test_set_config_file_world_readable(self):
 
         # Return TypeError when world_readable type is not a bool
 
         kwargs = {'world_readable': 'True'}
         self.assertRaises(TypeError, tools.set_config_file, **kwargs)
 
+    def test_set_config_expected_warning_msg(self):
+
+        # Check that UserWarning is being called with http plotly_domain
+
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter("always")
+            kwargs = {'plotly_domain': 'http://www.foo-bar.com'}
+            tools.set_config_file(**kwargs)
+            assert len(w) == 1
+            assert issubclass(w[-1].category, UserWarning)
+            assert "plotly_domain" in str(w[-1].message)
+
+
+    def test_set_config_no_warning_msg_if_plotly_domain_is_https(self):
+
+        # Check that no UserWarning is being called with https plotly_domain
+
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter("always")
+            kwargs = {'plotly_domain': 'https://www.foo-bar.com'}
+            tools.set_config_file(**kwargs)
+            assert len(w) == 0
+
+
     def test_reset_config_file(self):
 
         # Check reset_config and get_config return the same values
diff --git a/plotly/tools.py b/plotly/tools.py
@@ -191,6 +191,7 @@ def set_config_file(plotly_domain=None,
     ensure_local_plotly_files()  # make sure what's there is OK
     utils.validate_world_readable_and_sharing_settings({
         'sharing': sharing, 'world_readable': world_readable})
+
     settings = get_config_file()
     if isinstance(plotly_domain, six.string_types):
         settings['plotly_domain'] = plotly_domain
@@ -217,6 +218,11 @@ def set_config_file(plotly_domain=None,
     elif auto_open is not None:
         raise TypeError('auto_open should be a boolean')
 
+    # validate plotly_domain and plotly_api_domain
+    utils.validate_plotly_domains(
+        {'plotly_domain': plotly_domain, 'plotly_api_domain': plotly_api_domain}
+    )
+
     if isinstance(world_readable, bool):
         settings['world_readable'] = world_readable
         settings.pop('sharing')
diff --git a/plotly/utils.py b/plotly/utils.py
@@ -7,12 +7,12 @@
 """
 from __future__ import absolute_import
 
+import decimal
 import os.path
 import re
 import sys
 import textwrap
 import threading
-import decimal
 import datetime
 from collections import deque
 from pprint import PrettyPrinter
@@ -39,6 +39,30 @@
 )
 
 
+http_msg = (
+    "The plotly_domain and plotly_api_domain of your config file must start "
+    "with 'https', not 'http'. If you are not using On-Premise then run the "
+    "following code to ensure your plotly_domain and plotly_api_domain start "
+    "with 'https':\n\n\n"
+    "import plotly\n"
+    "plotly.tools.set_config_file(\n"
+    "    plotly_domain='https://plot.ly',\n"
+    "    plotly_api_domain='https://api.plot.ly'\n"
+    ")\n\n\n"
+    "If you are using On-Premise then you will need to use your company's "
+    "domain and api_domain urls:\n\n\n"
+    "import plotly\n"
+    "plotly.tools.set_config_file(\n"
+    "    plotly_domain='https://plotly.your-company.com',\n"
+    "    plotly_api_domain='https://plotly.your-company.com'\n"
+    ")\n\n\n"
+    "Make sure to replace `your-company.com` with the URL of your Plotly "
+    "On-Premise server.\nSee "
+    "https://plot.ly/python/getting-started/#special-instructions-for-plotly-onpremise-users "
+    "for more help with getting started with On-Premise."
+)
+
+
 ### general file setup tools ###
 
 def load_json_dict(filename, *args):
@@ -306,6 +330,7 @@ def encode_as_decimal(obj):
         else:
             raise NotEncodable
 
+
 ### unicode stuff ###
 def decode_unicode(coll):
     if isinstance(coll, list):
@@ -445,6 +470,16 @@ def validate_world_readable_and_sharing_settings(option_set):
         )
 
 
+def validate_plotly_domains(option_set):
+    domains_not_none = []
+    for d in ['plotly_domain', 'plotly_api_domain']:
+        if d in option_set and option_set[d]:
+            domains_not_none.append(option_set[d])
+
+    if not all(d.lower().startswith('https') for d in domains_not_none):
+        warnings.warn(http_msg, category=UserWarning)
+
+
 def set_sharing_and_world_readable(option_set):
     if 'world_readable' in option_set and 'sharing' not in option_set:
         option_set['sharing'] = (
