figpack 0.2.1__py3-none-any.whl → 0.2.3__py3-none-any.whl

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/core/figpack_view.py

@@ -18,10 +18,13 @@ 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,
+        inline: Union[bool, None] = None,
+        inline_height: int = 600,
     ):
         """
         Display the visualization component
@@ -31,11 +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:
@@ -57,8 +86,11 @@ class FigpackView:
             open_in_browser=open_in_browser,
             allow_origin=allow_origin,
             upload=upload,
+            ephemeral=ephemeral,
             title=title,
             description=description,
+            inline=inline,
+            inline_height=inline_height,
         )
 
     def _write_to_zarr_group(self, group: zarr.Group) -> None: