figpack 0.2.31__py3-none-any.whl → 0.2.32__py3-none-any.whl

figpack/__init__.py

@@ -2,7 +2,7 @@
 figpack - A Python package for creating shareable, interactive visualizations in the browser
 """
 
-__version__ = "0.2.31"
+__version__ = "0.2.32"
 
 from .cli import view_figure
 from .core import FigpackView, FigpackExtension, ExtensionView

figpack/core/_save_figure.py

@@ -5,7 +5,9 @@ from ._bundle_utils import prepare_figure_bundle
 from .figpack_view import FigpackView
 
 
-def _save_figure(view: FigpackView, output_path: str, *, title: str):
+def _save_figure(
+    view: FigpackView, output_path: str, *, title: str, description: str = ""
+) -> None:
     """
     Save the figure to a folder or a .tar.gz file
 
@@ -19,7 +21,7 @@ def _save_figure(view: FigpackView, output_path: str, *, title: str):
     ):
         # It's a .tar.gz file
         with tempfile.TemporaryDirectory(prefix="figpack_save_") as tmpdir:
-            prepare_figure_bundle(view, tmpdir, title=title)
+            prepare_figure_bundle(view, tmpdir, title=title, description=description)
             # Create tar.gz file
             import tarfile
 
@@ -28,4 +30,6 @@ def _save_figure(view: FigpackView, output_path: str, *, title: str):
     else:
         # It's a folder
         output_path.mkdir(parents=True, exist_ok=True)
-        prepare_figure_bundle(view, str(output_path), title=title)
+        prepare_figure_bundle(
+            view, str(output_path), title=title, description=description
+        )

figpack/core/figpack_view.py

@@ -166,7 +166,7 @@ class FigpackView:
             _local_figure_name=_local_figure_name if _dev else None,
         )
 
-    def save(self, output_path: str, *, title: str) -> None:
+    def save(self, output_path: str, *, title: str, description: str = "") -> None:
         """
         Save as figure either to a folder or to a .tar.gz file
         Args:
@@ -174,7 +174,7 @@ class FigpackView:
         """
         from ._save_figure import _save_figure
 
-        _save_figure(self, output_path, title=title)
+        _save_figure(self, output_path, title=title, description=description)
 
     def write_to_zarr_group(self, group: Group) -> None:
         """