figpack 0.1.0__tar.gz → 0.1.2__tar.gz

{figpack-0.1.0 → figpack-0.1.2}/MANIFEST.in

@@ -1,8 +1,8 @@
 include README.md
 include LICENSE
 include pyproject.toml
-include build_gui.py
 recursive-include figpack *.py
 recursive-include figpack/figpack-gui-dist *
 global-exclude __pycache__
 global-exclude *.py[co]
+

figpack-0.1.2/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.4
+Name: figpack
+Version: 0.1.2
+Summary: A Python package for creating shareable, interactive visualizations in the browser
+Author-email: Jeremy Magland <jmagland@flatironinstitute.org>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/magland/figpack
+Project-URL: Repository, https://github.com/magland/figpack
+Project-URL: Documentation, https://github.com/magland/figpack#readme
+Project-URL: Bug Tracker, https://github.com/magland/figpack/issues
+Keywords: visualization,plotting,timeseries,interactive
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: zarr
+Requires-Dist: requests
+Dynamic: license-file
+
+# figpack
+
+A Python package for creating shareable, interactive visualizations in the browser.
+
+## Overview
+
+figpack enables you to create interactive data visualizations that can be displayed in a web browser and optionally shared online. The package focuses on timeseries data visualization with support for complex, nested layouts.
+
+### Key Features
+
+- **Interactive timeseries graphs** with line series, markers, and interval plots
+- **Flexible layout system** with boxes, splitters, and tab layouts
+- **Web-based rendering** that works in any modern browser
+- **Shareable visualizations** that can be uploaded and shared via URLs
+- **Zarr-based data storage** for efficient handling of large datasets
+
+## Installation
+
+Install figpack using pip:
+
+```bash
+pip install figpack
+```
+
+## Quick Start
+
+```python
+import numpy as np
+import figpack.views as vv
+
+# Create a timeseries graph
+graph = vv.TimeseriesGraph(y_label="Signal")
+
+# Add some data
+t = np.linspace(0, 10, 1000)
+y = np.sin(2 * np.pi * t)
+graph.add_line_series(name="sine wave", t=t, y=y, color="blue")
+
+# Display the visualization
+graph.show(open_in_browser=True)
+```
+
+## Examples
+
+See the `examples/` directory.
+
+## Usage Modes
+
+### Local Development
+
+```python
+view.show(open_in_browser=True)
+```
+
+### Sharing Online
+
+Set the `FIGPACK_UPLOAD_PASSCODE` environment variable and use:
+
+```python
+view.show(upload=True, open_in_browser=True)
+```
+
+### Development Mode
+
+Set `_dev=True` in the call to show() to enable development mode, which allows for live updates and debugging with figpack-gui.
+
+## License
+
+Apache-2.0
+
+## Contributing
+
+Visit the [GitHub repository](https://github.com/magland/figpack) for issues, contributions, and the latest updates.

figpack-0.1.2/README.md

@@ -0,0 +1,73 @@
+# figpack
+
+A Python package for creating shareable, interactive visualizations in the browser.
+
+## Overview
+
+figpack enables you to create interactive data visualizations that can be displayed in a web browser and optionally shared online. The package focuses on timeseries data visualization with support for complex, nested layouts.
+
+### Key Features
+
+- **Interactive timeseries graphs** with line series, markers, and interval plots
+- **Flexible layout system** with boxes, splitters, and tab layouts
+- **Web-based rendering** that works in any modern browser
+- **Shareable visualizations** that can be uploaded and shared via URLs
+- **Zarr-based data storage** for efficient handling of large datasets
+
+## Installation
+
+Install figpack using pip:
+
+```bash
+pip install figpack
+```
+
+## Quick Start
+
+```python
+import numpy as np
+import figpack.views as vv
+
+# Create a timeseries graph
+graph = vv.TimeseriesGraph(y_label="Signal")
+
+# Add some data
+t = np.linspace(0, 10, 1000)
+y = np.sin(2 * np.pi * t)
+graph.add_line_series(name="sine wave", t=t, y=y, color="blue")
+
+# Display the visualization
+graph.show(open_in_browser=True)
+```
+
+## Examples
+
+See the `examples/` directory.
+
+## Usage Modes
+
+### Local Development
+
+```python
+view.show(open_in_browser=True)
+```
+
+### Sharing Online
+
+Set the `FIGPACK_UPLOAD_PASSCODE` environment variable and use:
+
+```python
+view.show(upload=True, open_in_browser=True)
+```
+
+### Development Mode
+
+Set `_dev=True` in the call to show() to enable development mode, which allows for live updates and debugging with figpack-gui.
+
+## License
+
+Apache-2.0
+
+## Contributing
+
+Visit the [GitHub repository](https://github.com/magland/figpack) for issues, contributions, and the latest updates.

{figpack-0.1.0 → figpack-0.1.2}/figpack/__init__.py

@@ -1,5 +1,5 @@
 """
-figpack - A Python package for creating interactive visualizations
+figpack - A Python package for creating shareable, interactive visualizations in the browser
 """
 
 __version__ = "0.1.0"

figpack-0.1.2/figpack/core/_bundle_utils.py

@@ -0,0 +1,56 @@
+import os
+import pathlib
+import zarr
+from .figpack_view import FigpackView
+
+thisdir = pathlib.Path(__file__).parent.resolve()
+
+
+def prepare_figure_bundle(
+    view: FigpackView, tmpdir: str, *, title: str = None, description: str = None
+) -> None:
+    """
+    Prepare a figure bundle in the specified temporary directory.
+
+    This function:
+    1. Copies all files from the figpack-gui-dist directory to tmpdir
+    2. Writes the view data to a zarr group
+    3. Consolidates zarr metadata
+
+    Args:
+        view: The figpack view to prepare
+        tmpdir: The temporary directory to prepare the bundle in
+        title: Optional title for the figure
+        description: Optional description for the figure (markdown supported)
+    """
+    html_dir = thisdir / ".." / "figpack-gui-dist"
+    if not os.path.exists(html_dir):
+        raise SystemExit(f"Error: directory not found: {html_dir}")
+
+    # Copy all files in html_dir recursively to tmpdir
+    for item in html_dir.iterdir():
+        if item.is_file():
+            target = pathlib.Path(tmpdir) / item.name
+            target.write_bytes(item.read_bytes())
+        elif item.is_dir():
+            target = pathlib.Path(tmpdir) / item.name
+            target.mkdir(exist_ok=True)
+            for subitem in item.iterdir():
+                target_sub = target / subitem.name
+                target_sub.write_bytes(subitem.read_bytes())
+
+    # Write the graph data to the Zarr group
+    zarr_group = zarr.open_group(
+        pathlib.Path(tmpdir) / "data.zarr",
+        mode="w",
+        synchronizer=zarr.ThreadSynchronizer(),
+    )
+    view._write_to_zarr_group(zarr_group)
+
+    # Add title and description as attributes on the top-level zarr group
+    if title is not None:
+        zarr_group.attrs["title"] = title
+    if description is not None:
+        zarr_group.attrs["description"] = description
+
+    zarr.consolidate_metadata(zarr_group.store)

{figpack-0.1.0/figpack → figpack-0.1.2/figpack/core}/_show_view.py

@@ -1,7 +1,6 @@
 import os
 
 from typing import Union
-import zarr
 import tempfile
 
 import webbrowser
@@ -11,50 +10,54 @@ import pathlib
 import threading
 from http.server import SimpleHTTPRequestHandler, ThreadingHTTPServer
 
-from .views import TimeseriesGraph
+from .figpack_view import FigpackView
+from ._bundle_utils import prepare_figure_bundle
+from ._upload_bundle import _upload_bundle
 
 thisdir = pathlib.Path(__file__).parent.resolve()
 
 
 def _show_view(
-    view: TimeseriesGraph,
+    view: FigpackView,
     *,
     open_in_browser: bool = False,
     port: Union[int, None] = None,
     allow_origin: Union[str, None] = None,
+    upload: bool = False,
+    title: Union[str, None] = None,
+    description: Union[str, None] = None,
 ):
     with tempfile.TemporaryDirectory(prefix="figpack_") as tmpdir:
-        html_dir = thisdir / "figpack-gui-dist"
-        if not os.path.exists(html_dir):
-            raise SystemExit(f"Error: directory not found: {html_dir}")
-        # copy all files in html_dir recursively to tmpdir
-        for item in html_dir.iterdir():
-            if item.is_file():
-                target = pathlib.Path(tmpdir) / item.name
-                target.write_bytes(item.read_bytes())
-            elif item.is_dir():
-                target = pathlib.Path(tmpdir) / item.name
-                target.mkdir(exist_ok=True)
-                for subitem in item.iterdir():
-                    target_sub = target / subitem.name
-                    target_sub.write_bytes(subitem.read_bytes())
-
-        # Write the graph data to the Zarr group
-        zarr_group = zarr.open_group(
-            pathlib.Path(tmpdir) / "data.zarr",
-            mode="w",
-            synchronizer=zarr.ThreadSynchronizer(),
-        )
-        view._write_to_zarr_group(zarr_group)
-
-        zarr.consolidate_metadata(zarr_group.store)
-
-        serve_files(
-            tmpdir,
-            port=port,
-            open_in_browser=open_in_browser,
-            allow_origin=allow_origin,
-        )
+        prepare_figure_bundle(view, tmpdir, title=title, description=description)
+
+        if upload:
+            # Check for required environment variable
+            passcode = os.environ.get("FIGPACK_UPLOAD_PASSCODE")
+            if not passcode:
+                raise EnvironmentError(
+                    "FIGPACK_UPLOAD_PASSCODE environment variable must be set to upload views."
+                )
+
+            # Upload the bundle
+            print("Starting upload...")
+            figure_url = _upload_bundle(tmpdir, passcode)
+
+            if open_in_browser:
+                webbrowser.open(figure_url)
+                print(f"Opening {figure_url} in browser.")
+                # wait until user presses Enter
+                input("Press Enter to continue...")
+            else:
+                print(f"View the figure at: {figure_url}")
+
+            return figure_url
+        else:
+            serve_files(
+                tmpdir,
+                port=port,
+                open_in_browser=open_in_browser,
+                allow_origin=allow_origin,
+            )
 
 
 class CORSRequestHandler(SimpleHTTPRequestHandler):