figpack 0.3.1__tar.gz → 0.3.4__tar.gz

{figpack-0.3.1/figpack.egg-info → figpack-0.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: figpack
-Version: 0.3.1
+Version: 0.3.4
 Summary: A Python package for creating shareable, interactive visualizations in the browser
 Author-email: Jeremy Magland <jmagland@flatironinstitute.org>
 License: Apache-2.0
@@ -133,7 +133,7 @@ If you use figpack in your research, please cite it:
 
 Or in APA format:
 
-> Magland, J. (2025). figpack (Version 0.3.1) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.17419621
+> Magland, J. (2025). figpack (Version 0.3.4) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.17419621
 
 ## Contributing
 

{figpack-0.3.1 → figpack-0.3.4}/README.md

@@ -57,7 +57,7 @@ If you use figpack in your research, please cite it:
 
 Or in APA format:
 
-> Magland, J. (2025). figpack (Version 0.3.1) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.17419621
+> Magland, J. (2025). figpack (Version 0.3.4) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.17419621
 
 ## Contributing
 

{figpack-0.3.1 → figpack-0.3.4}/figpack/__init__.py

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

{figpack-0.3.1 → figpack-0.3.4}/figpack/cli.py

@@ -16,9 +16,8 @@ from urllib.parse import urljoin
 import requests
 
 from . import __version__
-from .core._server_manager import CORSRequestHandler
-from .core._view_figure import serve_files, view_figure
-from .core._upload_bundle import _upload_bundle, get_figure_by_source_url
+from .core._view_figure import view_figure
+from .core._upload_bundle import _upload_bundle
 from .extensions import ExtensionManager
 
 MAX_WORKERS_FOR_DOWNLOAD = 16
@@ -250,130 +249,6 @@ def handle_extensions_command(args):
         print("Use 'figpack extensions <command> --help' for more information.")
 
 
-def handle_upload_from_source_url(args) -> None:
-    """
-    Handle the upload-from-source-url command
-
-    Downloads a tar.gz/tgz file from a URL, extracts it, and uploads it as a new figure
-    with the source URL set.
-    """
-    import os
-
-    source_url = args.source_url
-    title = args.title if hasattr(args, "title") else None
-
-    # Get API key from environment variable
-    api_key = os.environ.get("FIGPACK_API_KEY")
-    if not api_key:
-        print(
-            "Error: FIGPACK_API_KEY environment variable must be set to upload figures."
-        )
-        sys.exit(1)
-
-    # Validate URL format
-    if not (source_url.endswith(".tar.gz") or source_url.endswith(".tgz")):
-        print(f"Error: Source URL must point to a .tar.gz or .tgz file: {source_url}")
-        sys.exit(1)
-
-    print(f"Downloading archive from: {source_url}")
-
-    try:
-        # Download the archive
-        response = requests.get(source_url, timeout=120, stream=True)
-        response.raise_for_status()
-
-        # Create temporary file for the archive
-        with tempfile.NamedTemporaryFile(
-            suffix=".tar.gz", delete=False
-        ) as temp_archive:
-            archive_path = temp_archive.name
-
-            # Download with progress indication
-            total_size = int(response.headers.get("content-length", 0))
-            downloaded_size = 0
-
-            for chunk in response.iter_content(chunk_size=8192):
-                if chunk:
-                    temp_archive.write(chunk)
-                    downloaded_size += len(chunk)
-                    if total_size > 0:
-                        progress = (downloaded_size / total_size) * 100
-                        print(
-                            f"Downloaded: {downloaded_size / (1024*1024):.2f} MB ({progress:.1f}%)",
-                            end="\r",
-                        )
-
-            if total_size > 0:
-                print()  # New line after progress
-            print(f"Download complete: {downloaded_size / (1024*1024):.2f} MB")
-
-        # Extract archive to temporary directory
-        print("Extracting archive...")
-        with tempfile.TemporaryDirectory() as extract_dir:
-            extract_path = pathlib.Path(extract_dir)
-
-            try:
-                with tarfile.open(archive_path, "r:gz") as tar:
-                    tar.extractall(path=extract_path)
-                print(f"Extracted to temporary directory")
-            except Exception as e:
-                print(f"Error: Failed to extract archive: {e}")
-                sys.exit(1)
-            finally:
-                # Clean up downloaded archive
-                import os
-
-                try:
-                    os.unlink(archive_path)
-                except Exception:
-                    pass
-
-            # Upload the extracted files
-            print(f"Uploading figure with source URL: {source_url}")
-            try:
-                figure_url = _upload_bundle(
-                    str(extract_path),
-                    api_key=api_key,
-                    title=title,
-                    source_url=source_url,
-                )
-                print(f"\nFigure uploaded successfully!")
-                print(f"Figure URL: {figure_url}")
-            except Exception as e:
-                print(f"Error: Failed to upload figure: {e}")
-                sys.exit(1)
-
-    except requests.exceptions.RequestException as e:
-        print(f"Error: Failed to download archive from {source_url}: {e}")
-        sys.exit(1)
-    except Exception as e:
-        print(f"Error: {e}")
-        sys.exit(1)
-
-
-def handle_find_by_source_url(args) -> None:
-    """
-    Handle the find-by-source-url command
-
-    Queries the API for a figure URL by its source URL.
-    """
-    source_url = args.source_url
-
-    print(f"Querying for figure with source URL: {source_url}")
-
-    try:
-        figure_url = get_figure_by_source_url(source_url)
-
-        if figure_url:
-            print(f"Figure found: {figure_url}")
-        else:
-            print(f"No figure found with source URL: {source_url}")
-            sys.exit(1)
-    except Exception as e:
-        print(f"Error: {e}")
-        sys.exit(1)
-
-
 def download_and_view_archive(url: str, port: int = None) -> None:
     """
     Download a tar.gz/tgz archive from a URL and view it
@@ -495,27 +370,6 @@ def main():
         "extensions", nargs="+", help="Extension package names to uninstall"
     )
 
-    # Upload from URL command
-    upload_from_source_url_parser = subparsers.add_parser(
-        "upload-from-source-url",
-        help="Download a tar.gz/tgz file and upload it as a new figure",
-    )
-    upload_from_source_url_parser.add_argument(
-        "source_url",
-        help="URL to the tar.gz or tgz file (will be set as the figure's source URL)",
-    )
-    upload_from_source_url_parser.add_argument(
-        "--title", help="Optional title for the figure"
-    )
-
-    # Find by source URL command
-    find_by_source_url_parser = subparsers.add_parser(
-        "find-by-source-url", help="Get the figure URL for a given source URL"
-    )
-    find_by_source_url_parser.add_argument(
-        "source_url", help="The source URL to search for"
-    )
-
     args = parser.parse_args()
 
     if args.command == "download":
@@ -528,10 +382,6 @@ def main():
             view_figure(args.archive, port=args.port)
     elif args.command == "extensions":
         handle_extensions_command(args)
-    elif args.command == "upload-from-source-url":
-        handle_upload_from_source_url(args)
-    elif args.command == "find-by-source-url":
-        handle_find_by_source_url(args)
     else:
         parser.print_help()
 

{figpack-0.3.1 → figpack-0.3.4}/figpack/core/_bundle_utils.py

@@ -15,7 +15,12 @@ thisdir = pathlib.Path(__file__).parent.resolve()
 
 
 def prepare_figure_bundle(
-    view: FigpackView, tmpdir: str, *, title: str, description: Optional[str] = None
+    view: FigpackView,
+    tmpdir: str,
+    *,
+    title: str,
+    description: Optional[str] = None,
+    script: Optional[str] = None,
 ) -> None:
     """
     Prepare a figure bundle in the specified temporary directory.
@@ -31,6 +36,7 @@ def prepare_figure_bundle(
         tmpdir: The temporary directory to prepare the bundle in
         title: Title for the figure (required)
         description: Optional description for the figure (markdown supported)
+        script: Optional script text used to generate the figure
     """
     html_dir = thisdir / ".." / "figpack-figure-dist"
     if not os.path.exists(html_dir):
@@ -61,10 +67,12 @@ def prepare_figure_bundle(
         zarr_group = Group(zarr_group)
         view.write_to_zarr_group(zarr_group)
 
-        # Add title and description as attributes on the top-level zarr group
+        # Add title and description and script as attributes on the top-level zarr group
         zarr_group.attrs["title"] = title
-        if description is not None:
+        if description:
             zarr_group.attrs["description"] = description
+        if script:
+            zarr_group.attrs["script"] = script
 
         # Discover and write extension JavaScript files
         required_extensions = _discover_required_extensions(view)

{figpack-0.3.1 → figpack-0.3.4}/figpack/core/_save_figure.py

@@ -6,7 +6,12 @@ from .figpack_view import FigpackView
 
 
 def _save_figure(
-    view: FigpackView, output_path: str, *, title: str, description: str = ""
+    view: FigpackView,
+    output_path: str,
+    *,
+    title: str,
+    description: str = "",
+    script: str = "",
 ) -> None:
     """
     Save the figure to a folder or a .tar.gz file
@@ -14,6 +19,9 @@ def _save_figure(
     Args:
         view: FigpackView instance to save
         output_path: Output path (destination folder or .tar.gz file path)
+        title: Title for the figure
+        description: Description text with markdown support
+        script: Optional script text used to generate the figure
     """
     output_path_2 = pathlib.Path(output_path)
     if (output_path_2.suffix == ".gz" and output_path_2.suffixes[-2] == ".tar") or (
@@ -21,7 +29,9 @@ def _save_figure(
     ):
         # It's a .tar.gz file
         with tempfile.TemporaryDirectory(prefix="figpack_save_") as tmpdir:
-            prepare_figure_bundle(view, tmpdir, title=title, description=description)
+            prepare_figure_bundle(
+                view, tmpdir, title=title, description=description, script=script
+            )
             # Create tar.gz file
             import tarfile
 
@@ -31,5 +41,9 @@ def _save_figure(
         # It's a folder
         output_path_2.mkdir(parents=True, exist_ok=True)
         prepare_figure_bundle(
-            view, str(output_path_2), title=title, description=description
+            view,
+            str(output_path_2),
+            title=title,
+            description=description,
+            script=script,
         )

{figpack-0.3.1 → figpack-0.3.4}/figpack/core/_show_view.py

@@ -91,6 +91,7 @@ def _show_view(
     ephemeral: bool,
     title: str,
     description: Union[str, None],
+    script: Union[str, None],
     inline: bool,
     inline_height: int,
     wait_for_input: bool,
@@ -99,7 +100,9 @@ def _show_view(
     if upload:
         # Upload behavior: create temporary directory for this upload only
         with tempfile.TemporaryDirectory(prefix="figpack_upload_") as tmpdir:
-            prepare_figure_bundle(view, tmpdir, title=title, description=description)
+            prepare_figure_bundle(
+                view, tmpdir, title=title, description=description, script=script
+            )
 
             # Check for API key - required for regular uploads, optional for ephemeral
             api_key = os.environ.get("FIGPACK_API_KEY")
@@ -143,7 +146,7 @@ def _show_view(
 
         # Prepare the figure bundle in the subdirectory
         prepare_figure_bundle(
-            view, str(figure_dir), title=title, description=description
+            view, str(figure_dir), title=title, description=description, script=script
         )
 
         # Start or get existing server

{figpack-0.3.1 → figpack-0.3.4}/figpack/core/_upload_bundle.py

@@ -134,7 +134,6 @@ def _create_or_get_figure(
     total_size: Optional[int] = None,
     title: Optional[str] = None,
     ephemeral: bool = False,
-    source_url: Optional[str] = None,
 ) -> dict:
     """
     Create a new figure or get existing figure information
@@ -145,7 +144,6 @@ def _create_or_get_figure(
         total_size: Optional total size of files
         title: Optional title for the figure
         ephemeral: Whether to create an ephemeral figure
-        source_url: Optional source URL for the figure (must be unique)
 
     Returns:
         dict: Figure information from the API
@@ -171,8 +169,6 @@ def _create_or_get_figure(
         payload["title"] = title
     if ephemeral:
         payload["ephemeral"] = True
-    if source_url is not None:
-        payload["sourceUrl"] = source_url
 
     # Use the same endpoint for both regular and ephemeral figures
     url = f"{FIGPACK_API_BASE_URL}/figures/create"
@@ -242,7 +238,6 @@ def _upload_bundle(
     title: Optional[str] = None,
     ephemeral: bool = False,
     use_consolidated_metadata_only: bool = False,
-    source_url: Optional[str] = None,
 ) -> str:
     """
     Upload the prepared bundle to the cloud using the new database-driven approach
@@ -254,7 +249,6 @@ def _upload_bundle(
         ephemeral: Whether to create an ephemeral figure
         use_consolidated_metadata_only: If True, excludes individual zarr metadata files
             (.zgroup, .zarray, .zattrs) since they are included in .zmetadata
-        source_url: Optional source URL for the figure (must be unique)
     """
     tmpdir_path = pathlib.Path(tmpdir)
 
@@ -283,7 +277,6 @@ def _upload_bundle(
         total_size,
         title=title,
         ephemeral=ephemeral,
-        source_url=source_url,
     )
     figure_info = result.get("figure", {})
     figure_url = figure_info.get("figureUrl")
@@ -418,39 +411,6 @@ def _upload_bundle(
     return figure_url
 
 
-def get_figure_by_source_url(source_url: str) -> Optional[str]:
-    """
-    Query the API for a figure URL by its source URL
-
-    Args:
-        source_url: The source URL to search for
-
-    Returns:
-        Optional[str]: The figure URL if found, None otherwise
-    """
-    payload = {"sourceUrl": source_url}
-
-    response = requests.post(
-        f"{FIGPACK_API_BASE_URL}/figures/find-by-source-url", json=payload
-    )
-
-    if not response.ok:
-        if response.status_code == 404:
-            return None
-        try:
-            error_data = response.json()
-            error_msg = error_data.get("message", "Unknown error")
-        except:
-            error_msg = f"HTTP {response.status_code}"
-        raise Exception(f"Failed to query figure by source URL: {error_msg}")
-
-    response_data = response.json()
-    if not response_data.get("success"):
-        return None
-
-    return response_data.get("figureUrl")
-
-
 def _determine_content_type(file_path: str) -> str:
     """
     Determine content type for upload based on file extension

{figpack-0.3.1 → figpack-0.3.4}/figpack/core/_view_figure.py

@@ -131,9 +131,7 @@ def view_figure(figure_path: str, port: Union[int, None] = None) -> None:
         )
         return
 
-    if not figure_pathlib.suffix.lower() in [".gz", ".tgz"] or not str(
-        figure_pathlib
-    ).endswith(".tar.gz"):
+    if not figure_path.endswith(".tar.gz") and not figure_path.endswith(".tgz"):
         print(f"Error: Archive file must be a .tar.gz file: {figure_path}")
         sys.exit(1)
 

{figpack-0.3.1 → figpack-0.3.4}/figpack/core/figpack_view.py

@@ -20,6 +20,7 @@ class FigpackView:
         *,
         title: str,
         description: Optional[str] = None,
+        script: Optional[str] = None,
         port: Optional[int] = None,
         open_in_browser: Optional[bool] = None,
         upload: Optional[bool] = None,
@@ -29,7 +30,7 @@ class FigpackView:
         allow_origin: Optional[str] = None,
         wait_for_input: Optional[bool] = None,
         _dev: Optional[bool] = None,
-    ) -> None:
+    ):
         """
         Display a figpack view component with intelligent environment detection and flexible display options.
         See https://flatironinstitute.github.io/figpack/show_function.html for complete documentation.
@@ -41,6 +42,7 @@ class FigpackView:
         Args:
             title: Title for browser tab and figure (required)
             description: Description text with markdown support (optional)
+            script: Optional script text used to generate the figure
             port: Local server port, random if None
             open_in_browser: Auto-open in browser, auto-detects by environment
             upload: Upload figure to figpack servers, auto-detects by environment
@@ -161,7 +163,7 @@ class FigpackView:
             )
             print("")
 
-        _show_view(
+        return _show_view(
             self,
             port=port,
             open_in_browser=open_in_browser,
@@ -170,21 +172,29 @@ class FigpackView:
             ephemeral=ephemeral,
             title=title,
             description=description,
+            script=script,
             inline=inline,
             inline_height=inline_height,
             wait_for_input=wait_for_input,
             _local_figure_name=_local_figure_name if _dev else None,
         )
 
-    def save(self, output_path: str, *, title: str, description: str = "") -> None:
+    def save(
+        self, output_path: str, *, title: str, description: str = "", script: str = ""
+    ) -> None:
         """
         Save as figure either to a folder or to a .tar.gz file
         Args:
             output_path: Output path (destination folder or .tar.gz file path)
+            title: Title for the figure
+            description: Description text with markdown support
+            script: Optional script text used to generate the figure
         """
         from ._save_figure import _save_figure
 
-        _save_figure(self, output_path, title=title, description=description)
+        _save_figure(
+            self, output_path, title=title, description=description, script=script
+        )
 
     def write_to_zarr_group(self, group: Group) -> None:
         """