figpack 0.2.2__tar.gz → 0.2.3__tar.gz

{figpack-0.2.2/figpack.egg-info → figpack-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: figpack
-Version: 0.2.2
+Version: 0.2.3
 Summary: A Python package for creating shareable, interactive visualizations in the browser
 Author-email: Jeremy Magland <jmagland@flatironinstitute.org>
 License: Apache-2.0

{figpack-0.2.2 → figpack-0.2.3}/figpack/__init__.py

@@ -2,4 +2,4 @@
 figpack - A Python package for creating shareable, interactive visualizations in the browser
 """
 
-__version__ = "0.2.2"
+__version__ = "0.2.3"

{figpack-0.2.2 → figpack-0.2.3}/figpack/core/_show_view.py

@@ -38,6 +38,19 @@ def _is_in_notebook() -> bool:
         return False
 
 
+def _is_in_colab():
+    try:
+        import google.colab  # type: ignore
+
+        return True
+    except ImportError:
+        return False
+
+
+def _is_in_jupyterhub():
+    return "JUPYTERHUB_USER" in os.environ
+
+
 def _display_inline_iframe(url: str, height: int) -> None:
     """
     Display an iframe inline in a Jupyter notebook.
@@ -75,6 +88,7 @@ def _show_view(
     port: Union[int, None] = None,
     allow_origin: Union[str, None] = None,
     upload: bool = False,
+    ephemeral: bool = False,
     title: Union[str, None] = None,
     description: Union[str, None] = None,
     inline: Union[bool, None] = None,
@@ -91,16 +105,17 @@ def _show_view(
         with tempfile.TemporaryDirectory(prefix="figpack_upload_") as tmpdir:
             prepare_figure_bundle(view, tmpdir, title=title, description=description)
 
-            # Check for required environment variable
+            # Check for API key - required for regular uploads, optional for ephemeral
             api_key = os.environ.get("FIGPACK_API_KEY")
-            if not api_key:
+            if not ephemeral and not api_key:
                 raise EnvironmentError(
                     "FIGPACK_API_KEY environment variable must be set to upload views."
                 )
 
             # Upload the bundle
-            print("Starting upload...")
-            figure_url = _upload_bundle(tmpdir, api_key, title=title)
+            figure_url = _upload_bundle(
+                tmpdir, api_key, title=title, ephemeral=ephemeral
+            )
 
             if use_inline:
                 # For uploaded figures, display the remote URL inline and continue

{figpack-0.2.2 → figpack-0.2.3}/figpack/core/_upload_bundle.py

@@ -133,33 +133,45 @@ def _create_or_get_figure(
     total_files: int = None,
     total_size: int = None,
     title: str = None,
+    ephemeral: bool = False,
 ) -> dict:
     """
     Create a new figure or get existing figure information
 
     Args:
         figure_hash: The hash of the figure
-        api_key: The API key for authentication
+        api_key: The API key for authentication (required for non-ephemeral)
         total_files: Optional total number of files
         total_size: Optional total size of files
         title: Optional title for the figure
+        ephemeral: Whether to create an ephemeral figure
 
     Returns:
         dict: Figure information from the API
     """
+    # Validate API key requirement
+    if not ephemeral and api_key is None:
+        raise ValueError("API key is required for non-ephemeral figures")
+
     payload = {
         "figureHash": figure_hash,
-        "apiKey": api_key,
         "figpackVersion": __version__,
     }
 
+    # API key is optional for ephemeral figures
+    if api_key is not None:
+        payload["apiKey"] = api_key
+
     if total_files is not None:
         payload["totalFiles"] = total_files
     if total_size is not None:
         payload["totalSize"] = total_size
     if title is not None:
         payload["title"] = title
+    if ephemeral:
+        payload["ephemeral"] = True
 
+    # Use the same endpoint for both regular and ephemeral figures
     response = requests.post(f"{FIGPACK_API_BASE_URL}/api/figures/create", json=payload)
 
     if not response.ok:
@@ -212,16 +224,16 @@ def _finalize_figure(figure_url: str, api_key: str) -> dict:
     return response_data
 
 
-def _upload_bundle(tmpdir: str, api_key: str, title: str = None) -> str:
+def _upload_bundle(
+    tmpdir: str, api_key: str, title: str = None, ephemeral: bool = False
+) -> str:
     """
     Upload the prepared bundle to the cloud using the new database-driven approach
     """
     tmpdir_path = pathlib.Path(tmpdir)
 
     # Compute deterministic figure ID based on file contents
-    print("Computing deterministic figure ID...")
     figure_hash = _compute_deterministic_figure_hash(tmpdir_path)
-    print(f"Figure hash: {figure_hash}")
 
     # Collect all files to upload
     all_files = []
@@ -239,17 +251,15 @@ def _upload_bundle(tmpdir: str, api_key: str, title: str = None) -> str:
 
     # Find available figure ID and create/get figure in database with metadata
     result = _create_or_get_figure(
-        figure_hash, api_key, total_files, total_size, title=title
+        figure_hash, api_key, total_files, total_size, title=title, ephemeral=ephemeral
     )
     figure_info = result.get("figure", {})
     figure_url = figure_info.get("figureUrl")
 
     if figure_info["status"] == "completed":
-        print(f"Figure already exists at: {figure_url}")
+        print(f"Figure already exists. No upload needed.")
         return figure_url
 
-    print(f"Using figure URL: {figure_url}")
-
     files_to_upload = all_files
     total_files_to_upload = len(files_to_upload)
 

{figpack-0.2.2 → figpack-0.2.3}/figpack/core/figpack_view.py

@@ -18,7 +18,8 @@ class FigpackView:
         port: Union[int, None] = None,
         open_in_browser: bool = False,
         allow_origin: Union[str, None] = None,
-        upload: bool = False,
+        upload: Union[bool, None] = None,
+        ephemeral: Union[bool, None] = None,
         _dev: bool = False,
         title: Union[str, None] = None,
         description: Union[str, None] = None,
@@ -33,13 +34,37 @@ class FigpackView:
             open_in_browser: Whether to open in browser automatically
             allow_origin: CORS allow origin header
             upload: Whether to upload the figure
+            ephemeral: Whether to upload as ephemeral figure (None=auto-detect, True=force ephemeral, False=force regular)
             _dev: Development mode flag
             title: Title for the browser tab and figure
             description: Description text (markdown supported) for the figure
             inline: Whether to display inline in notebook (None=auto-detect, True=force inline, False=force browser)
             inline_height: Height in pixels for inline iframe display (default: 600)
         """
-        from ._show_view import _show_view
+        from ._show_view import (
+            _show_view,
+            _is_in_notebook,
+            _is_in_colab,
+            _is_in_jupyterhub,
+        )
+
+        if ephemeral is None and upload is None:
+            # If we haven't specified both, then let's check if we're in a notebook in a non-local environment
+            if _is_in_notebook():
+                if _is_in_colab():
+                    # if we are in a notebook and in colab, we should show as uploaded ephemeral
+                    print("Detected Google Colab notebook environment.")
+                    upload = True
+                    ephemeral = True
+                if _is_in_jupyterhub():
+                    # if we are in a notebook and in jupyterhub, we should show as uploaded ephemeral
+                    print("Detected JupyterHub notebook environment.")
+                    upload = True
+                    ephemeral = True
+
+        # Validate ephemeral parameter
+        if ephemeral and not upload:
+            raise ValueError("ephemeral=True requires upload=True to be set")
 
         if _dev:
             if port is None:
@@ -61,6 +86,7 @@ class FigpackView:
             open_in_browser=open_in_browser,
             allow_origin=allow_origin,
             upload=upload,
+            ephemeral=ephemeral,
             title=title,
             description=description,
             inline=inline,

{figpack-0.2.2 → figpack-0.2.3/figpack.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: figpack
-Version: 0.2.2
+Version: 0.2.3
 Summary: A Python package for creating shareable, interactive visualizations in the browser
 Author-email: Jeremy Magland <jmagland@flatironinstitute.org>
 License: Apache-2.0

{figpack-0.2.2 → figpack-0.2.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "figpack"
-version = "0.2.2"
+version = "0.2.3"
 description = "A Python package for creating shareable, interactive visualizations in the browser"
 readme = "README.md"
 requires-python = ">=3.8"

figpack-0.2.3/tests/test_figpack_view.py

@@ -0,0 +1,51 @@
+"""
+Tests for the FigpackView base class
+"""
+
+import pytest
+import zarr
+from unittest.mock import patch
+from figpack.core.figpack_view import FigpackView
+
+
+class TestFigpackView:
+    """Test cases for FigpackView class"""
+
+    def test_write_to_zarr_group_abstract(self):
+        """Test that _write_to_zarr_group raises NotImplementedError"""
+        view = FigpackView()
+        group = zarr.group()
+
+        with pytest.raises(NotImplementedError) as exc_info:
+            view._write_to_zarr_group(group)
+
+        assert "Subclasses must implement _write_to_zarr_group" in str(exc_info.value)
+
+    def test_show_dev_mode_constraints(self):
+        """Test development mode constraints in show method"""
+        view = FigpackView()
+
+        # Test that allow_origin cannot be set with _dev=True
+        with pytest.raises(ValueError) as exc_info:
+            view.show(_dev=True, allow_origin="http://example.com")
+        assert "Cannot set allow_origin when _dev is True" in str(exc_info.value)
+
+        # Test that upload cannot be used with _dev=True
+        with pytest.raises(ValueError) as exc_info:
+            view.show(_dev=True, upload=True)
+        assert "Cannot upload when _dev is True" in str(exc_info.value)
+
+    def test_show_with_title_and_description(self):
+        """Test show method with title and description"""
+        view = FigpackView()
+        title = "Test Figure"
+        description = "A test description"
+
+        with patch("figpack.core._show_view._show_view") as mock_show:
+            view.show(title=title, description=description)
+
+            mock_show.assert_called_once()
+            args = mock_show.call_args
+
+            assert args[1]["title"] == title
+            assert args[1]["description"] == description

figpack-0.2.2/tests/test_figpack_view.py

@@ -1,106 +0,0 @@
-"""
-Tests for the FigpackView base class
-"""
-
-import pytest
-import zarr
-from unittest.mock import patch
-from figpack.core.figpack_view import FigpackView
-
-
-class TestFigpackView:
-    """Test cases for FigpackView class"""
-
-    def test_write_to_zarr_group_abstract(self):
-        """Test that _write_to_zarr_group raises NotImplementedError"""
-        view = FigpackView()
-        group = zarr.group()
-
-        with pytest.raises(NotImplementedError) as exc_info:
-            view._write_to_zarr_group(group)
-
-        assert "Subclasses must implement _write_to_zarr_group" in str(exc_info.value)
-
-    def test_show_dev_mode_constraints(self):
-        """Test development mode constraints in show method"""
-        view = FigpackView()
-
-        # Test that allow_origin cannot be set with _dev=True
-        with pytest.raises(ValueError) as exc_info:
-            view.show(_dev=True, allow_origin="http://example.com")
-        assert "Cannot set allow_origin when _dev is True" in str(exc_info.value)
-
-        # Test that upload cannot be used with _dev=True
-        with pytest.raises(ValueError) as exc_info:
-            view.show(_dev=True, upload=True)
-        assert "Cannot upload when _dev is True" in str(exc_info.value)
-
-    def test_show_dev_mode_default_values(self, capfd):
-        """Test that development mode sets correct default values"""
-        view = FigpackView()
-
-        # Mock _show_view to avoid actual server startup
-        with patch("figpack.core._show_view._show_view") as mock_show:
-            view.show(_dev=True)
-
-            # Verify _show_view was called with correct parameters
-            mock_show.assert_called_once()
-            args = mock_show.call_args
-
-            assert args[1]["port"] == 3004
-            assert args[1]["allow_origin"] == "http://localhost:5173"
-            assert args[1]["upload"] is False
-            assert args[1]["open_in_browser"] is False
-
-            # Verify correct message was printed
-            captured = capfd.readouterr()
-            assert "For development, run figpack-gui in dev mode" in captured.out
-
-    def test_show_regular_usage(self):
-        """Test show method with standard parameters"""
-        view = FigpackView()
-        port = 8080
-
-        with patch("figpack.core._show_view._show_view") as mock_show:
-            # Test with various combinations of parameters
-            view.show(port=port, open_in_browser=True, allow_origin="http://test.com")
-
-            mock_show.assert_called_once()
-            args = mock_show.call_args
-
-            assert args[1]["port"] == port
-            assert args[1]["open_in_browser"] is True
-            assert args[1]["allow_origin"] == "http://test.com"
-            assert args[1]["upload"] is False
-
-    def test_show_with_title_and_description(self):
-        """Test show method with title and description"""
-        view = FigpackView()
-        title = "Test Figure"
-        description = "A test description"
-
-        with patch("figpack.core._show_view._show_view") as mock_show:
-            view.show(title=title, description=description)
-
-            mock_show.assert_called_once()
-            args = mock_show.call_args
-
-            assert args[1]["title"] == title
-            assert args[1]["description"] == description
-
-    def test_show_with_default_values(self):
-        """Test show method uses correct default values"""
-        view = FigpackView()
-
-        with patch("figpack.core._show_view._show_view") as mock_show:
-            view.show()
-
-            mock_show.assert_called_once()
-            args = mock_show.call_args
-
-            assert args[1]["port"] is None
-            assert args[1]["open_in_browser"] is False
-            assert args[1]["allow_origin"] is None
-            assert args[1]["upload"] is False
-            assert args[1]["title"] is None
-            assert args[1]["description"] is None