Merge pull request #330 from Dessia-tech/feat/offline

[7] Feat/offline

Author: Tanguylo

.gitignore

@@ -1,7 +1,3 @@
-node_modules/
-lib/
-libdev/
-
 # CAD files
 *.fcstd
 *.fcstd1
@@ -27,6 +23,7 @@ eggs/
 .eggs/
 lib/
 lib64/
+node_modules/
 parts/
 sdist/
 var/

.pre-commit-config.yaml

@@ -6,6 +6,7 @@ repos:
     rev: v3.2.0
     hooks:
       - id: trailing-whitespace
+        exclude: libdev/
       - id: check-docstring-first
       - id: check-json
       - id: check-added-large-files
@@ -14,3 +15,4 @@ repos:
       - id: requirements-txt-fixer
       - id: check-merge-conflict
       - id: end-of-file-fixer
+        exclude: libdev/

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Integer axes only show integer ticks
 - Handle date as continuous value on axes
 - Allow to log scale axes
+- Offline mode
 
 ### Fix
 - Add reference_path to all Primitive / Elementary drawing Objects

libdev/plot-data.js

@@ -127,21 +127,21 @@ def _export_formats(self) -> List[ExportFormat]:
         formats.append(ExportFormat(selector="html", extension="html", method_name="to_html_stream", text=False))
         return formats
 
-    def _to_html(self, debug_mode: bool = False, canvas_id: str = 'canvas', version: str = None):
-        lib_path = plot_data_path(debug_mode=debug_mode, version=version)
+    def _to_html(self, local: bool = False, canvas_id: str = 'canvas', version: str = None):
+        lib_path = plot_data_path(local=local, version=version)
         return self.template.substitute(data=json.dumps(self.to_dict()), core_path=lib_path, canvas_id=canvas_id,
                                         width=self.width, height=self.height)
 
-    def to_html_stream(self, stream, debug_mode: bool = False, canvas_id: str = 'canvas', version: str = None):
+    def to_html_stream(self, stream, local: bool = False, canvas_id: str = 'canvas', version: str = None):
         """ Export current Figure to its equivalent html stream file. """
-        html = self._to_html(debug_mode=debug_mode, canvas_id=canvas_id, version=version)
+        html = self._to_html(local=local, canvas_id=canvas_id, version=version)
         stream.write(html)
 
-    def to_html(self, filepath: str = None, debug_mode: bool = False, canvas_id: str = 'canvas', version: str = None):
+    def to_html(self, filepath: str = None, local: bool = False, canvas_id: str = 'canvas', version: str = None):
         """ Export current Figure to an HTML file given by the filepath. """
         filepath = make_filepath(filepath=filepath)
         with open(filepath, 'w', encoding="utf-8") as file:
-            self.to_html_stream(file, debug_mode=debug_mode, canvas_id=canvas_id, version=version)
+            self.to_html_stream(file, local=local, canvas_id=canvas_id, version=version)
         return filepath
 
     def plot_data(self, **kwargs):
@@ -1505,10 +1505,10 @@ def __init__(self, plots: List[PlotDataObject], sizes: List[Window] = None, elem
         super().__init__(width=width, height=height, type_='multiplot', name=name)
 
 
-def plot_data_path(debug_mode: bool = False, version: str = None):
+def plot_data_path(local: bool = False, version: str = None):
     """ Get path of plot_data package to write it in html file of Figure to draw. """
     version, folder, filename = get_current_link(version=version)
-    if debug_mode:
+    if local:
         core_path = os.sep.join(os.getcwd().split(os.sep)[:-1] + [folder, filename])
         if os.path.isfile(core_path):
             return core_path.replace(" ", "%20")
@@ -1526,17 +1526,17 @@ def make_filepath(filepath: str = None):
     return filepath
 
 
-def plot_canvas(plot_data_object: Figure, filepath: str = None, debug_mode: bool = False, canvas_id: str = 'canvas',
+def plot_canvas(plot_data_object: Figure, filepath: str = None, local: bool = False, canvas_id: str = 'canvas',
                 force_version: str = None, width: float = None, height: float = None):
     """
     Creates a html file and plots input data in web browser.
 
     :param plot_data_object: a PlotDataObject(ie Scatter, ParallelPlot,\
       MultiplePlots, Graph2D, PrimitiveGroup or PrimitiveGroupContainer)
     :type plot_data_object: PlotDataObject
-    :param debug_mode: uses local library if True, uses typescript \
+    :param local: uses local library if True, uses typescript \
     library from cdn if False
-    :type debug_mode: bool
+    :type local: bool
     :param canvas_id: set canvas' id, ie name
     :type canvas_id: str
     :param width: set the canvas' width:
@@ -1550,7 +1550,7 @@ def plot_canvas(plot_data_object: Figure, filepath: str = None, debug_mode: bool
         plot_data_object.width = width
     if height:
         plot_data_object.height = height
-    plot_data_object.plot(filepath=filepath, debug_mode=debug_mode, canvas_id=canvas_id, version=force_version)
+    plot_data_object.plot(filepath=filepath, local=local, canvas_id=canvas_id, version=force_version)
 
 
 def write_json_for_tests(plot_data_object: PlotDataObject, json_path: str):

plot_data/core.py

@@ -5,4 +5,4 @@
 # The graph's definition has been moved to test_objects.graph_test.py to
 # make MultiplePlots.py' imports more convenient
 plot_data_object = graph2d
-plot_data.plot_canvas(plot_data_object=graph2d, canvas_id='canvas', debug_mode=True)
+plot_data.plot_canvas(plot_data_object=graph2d, canvas_id='canvas', local=True)

script/graph2D.py

@@ -22,4 +22,4 @@
                                        surface_style=plot_data.SurfaceStyle("rgb(50, 50, 220)"),
                                        edge_style=plot_data.EdgeStyle(1, "rgb(0, 255, 0)", [5, 3]))
 
-plot_data.plot_canvas(plot_data_object=plot_data_object, debug_mode=True)
+plot_data.plot_canvas(plot_data_object=plot_data_object, local=True)

script/histogram.py

@@ -7,6 +7,7 @@
 """
 
 import random
+import plot_data
 
 random.seed(7)
 
@@ -37,4 +38,4 @@
 multipleplots = plot_data.MultiplePlots(elements=elements, plots=plots,
                                         initial_view_on=True)
 
-plot_data.plot_canvas(plot_data_object=multipleplots, debug_mode=True)
+plot_data.plot_canvas(plot_data_object=multipleplots, local=True)

script/minimal_dataviz.py

@@ -79,5 +79,5 @@
                                                            plot_data.PointFamily('rgb(146, 178, 78)', [11,21,31,41,25,26,27])])
 
 # Display
-plot_data_object.plot(debug_mode=True, canvas_id='canvas')
-# plot_data.plot_canvas(plot_data_object=multiplot, debug_mode=True)
+plot_data_object.plot(local=True, canvas_id='canvas')
+# plot_data.plot_canvas(plot_data_object=multiplot, local=True)

script/multiplot.py

@@ -18,4 +18,4 @@
                                                                                                                                 text_align_x='center',
                                                                                                                                 text_align_y='middle')))
 
-plot_data.plot_canvas(plotdata_nx_graph, debug_mode=True)
+plot_data.plot_canvas(plotdata_nx_graph, local=True)