Bundle and autodetect MathJax (#75)

* Bundle and autodetect MathJax 

These changes bundle MathJax. When MathJax is not bundled, the Python package looks for the `mathjax-path` script that is installed by the conda-forge MathJax pacakge.

Author: jonmmease

LICENSE.txt

@@ -8,6 +8,8 @@ of these dependencies.
 
 The CREDITS.html is also available at https://github.com/plotly/Kaleido/blob/master/repos/CREDITS.html
 
+The Kaleido python PyPI package vendors MathJax, which is released under the terms of the Apache License (3)
+
 (1) ----
 The MIT License (MIT)
 
@@ -59,3 +61,207 @@ THE SOFTWARE.
 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+(3) ----
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

repos/kaleido/py/kaleido/scopes/plotly.py

@@ -1,8 +1,10 @@
 from __future__ import absolute_import
-from kaleido.scopes.base import BaseScope
+from kaleido.scopes.base import BaseScope, which
 from _plotly_utils.utils import PlotlyJSONEncoder
 import base64
-
+import os
+from pathlib import Path
+import subprocess
 
 class PlotlyScope(BaseScope):
     """
@@ -19,10 +21,15 @@ def __init__(self, plotlyjs=None, mathjax=None, topojson=None, mapbox_access_tok
         # TODO: validate args
         # Save scope flags as internal properties
         self._plotlyjs = plotlyjs
-        self._mathjax = mathjax
         self._topojson = topojson
         self._mapbox_access_token = mapbox_access_token
 
+        # Try to find local MathJax, but never fail if something goes wrong
+        try:
+            self._initialize_mathax(mathjax)
+        except:
+            self._mathjax = None
+
         # to_image-level default values
         self.default_format = "png"
         self.default_width = 700
@@ -31,6 +38,37 @@ def __init__(self, plotlyjs=None, mathjax=None, topojson=None, mapbox_access_tok
 
         super(PlotlyScope, self).__init__(**kwargs)
 
+    def _initialize_mathax(self, mathjax=None):
+        if mathjax is not None:
+            self._mathjax = mathjax
+            return
+
+        vendored_mathjax_path = os.path.join(
+            os.path.dirname(os.path.dirname(os.path.abspath(__file__))),
+            'executable',
+            'etc',
+            'mathjax',
+            'MathJax.js'
+        )
+        mathjax_path = None
+        if os.path.exists(vendored_mathjax_path):
+            # MathJax is vendored under kaleido/executable.
+            # It was probably install as a PyPI wheel
+            mathjax_path = vendored_mathjax_path
+        else:
+            mathjax_path_executable = which("mathjax-path")
+            if mathjax_path_executable:
+                # A script named "mathjax-path" found on the PATH,
+                # MathJax was probably installed as a conda package
+                path_bytes = subprocess.check_output(mathjax_path_executable)
+                mathjax_path = path_bytes.decode("utf8").strip()
+
+        if mathjax_path:
+            mathjax_uri = Path(mathjax_path).absolute().as_uri()
+            self._mathjax = mathjax_uri
+        else:
+            self._mathjax = None
+
     @property
     def scope_name(self):
         return "plotly"

repos/kaleido/py/setup.py

@@ -294,6 +294,9 @@ def run(self):
     long_description=long_description,
     long_description_content_type="text/markdown",
     license="MIT",
+    install_requires=[
+        "pathlib ; python_version<'3.4'",
+    ],
     packages=["kaleido", "kaleido.scopes"],
     package_data={
         'kaleido': executable_files,

repos/linux_scripts/perform_kaleido_build

@@ -74,6 +74,10 @@ cp -r /etc/fonts/ /repos/build/kaleido/etc/fonts
 mkdir -p /repos/build/kaleido/xdg
 cp -r /usr/share/fonts/ /repos/build/kaleido/xdg/
 
+# mathjax
+unzip /repos/vendor/Mathjax-2.7.5.zip -d /repos/build/kaleido/etc/
+mv /repos/build/kaleido/etc/Mathjax-2.7.5 /repos/build/kaleido/etc/mathjax
+
 # Add full launch script
 cp /repos/linux_scripts/launch_script /repos/build/kaleido/kaleido
 

repos/mac_scripts/build_kaleido

@@ -64,6 +64,11 @@ rm -r ../build/kaleido/*
 mkdir -p ../build/kaleido/bin
 cp out/Kaleido_mac_$KALEIDO_ARCH/kaleido ../build/kaleido/bin
 
+# mathjax
+mkdir -p ../build/kaleido/etc
+unzip ../vendor/Mathjax-2.7.5.zip -d ../build/kaleido/etc/
+mv ../build/kaleido/etc/Mathjax-2.7.5 ../build/kaleido/etc/mathjax
+
 # Copy icudtl.dat and settings.dat
 cp ./out/Kaleido_mac_$KALEIDO_ARCH/icudtl.dat ../build/kaleido/bin
 

repos/vendor/Mathjax-2.7.5.zip

@@ -69,6 +69,13 @@ cp ..\kaleido\version ..\build\kaleido\
 cp ..\kaleido\LICENSE.txt ..\build\kaleido\
 cp ..\kaleido\CREDITS.html ..\build\kaleido\
 
+# mathjax
+if (-Not (Test-Path ..\build\kaleido\etc)) {
+    New-Item -Path ..\build\kaleido\etc -ItemType "directory"
+}
+Expand-Archive -LiteralPath '..\vendor\Mathjax-2.7.5.zip' -DestinationPath ..\build\kaleido\etc\
+Rename-Item -Path ..\build\kaleido\etc\Mathjax-2.7.5 -NewName mathjax
+
 # Copy icudtl.dat
 Copy-Item .\out\Kaleido_win_$arch\icudtl.dat -Destination ..\build\kaleido\bin
 
@@ -110,4 +117,4 @@ Compress-Archive -Path ..\build\kaleido -DestinationPath ..\build\kaleido_win_$a
 if (Test-Path ..\kaleido\py\kaleido_wheel.zip) {
     Remove-Item -Recurse -Force ..\kaleido\py\kaleido_wheel.zip
 }
-Compress-Archive -Path ..\kaleido\py\dist -DestinationPath ..\kaleido\py\kaleido_wheel.zip
+Compress-Archive -Path ..\kaleido\py\dist -DestinationPath ..\kaleido\py\kaleido_wheel.zip