figpack 0.1.4__tar.gz → 0.1.5__tar.gz

{figpack-0.1.4/figpack.egg-info → figpack-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: figpack
-Version: 0.1.4
+Version: 0.1.5
 Summary: A Python package for creating shareable, interactive visualizations in the browser
 Author-email: Jeremy Magland <jmagland@flatironinstitute.org>
 License: Apache-2.0
@@ -27,6 +27,19 @@ License-File: LICENSE
 Requires-Dist: numpy
 Requires-Dist: zarr
 Requires-Dist: requests
+Provides-Extra: test
+Requires-Dist: pytest>=7.0; extra == "test"
+Requires-Dist: pytest-cov>=4.0; extra == "test"
+Requires-Dist: pytest-mock>=3.10; extra == "test"
+Requires-Dist: spikeinterface; extra == "test"
+Requires-Dist: matplotlib; extra == "test"
+Requires-Dist: plotly; extra == "test"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: pytest-mock>=3.10; extra == "dev"
+Requires-Dist: black>=24.0; extra == "dev"
+Requires-Dist: pre-commit>=3.0; extra == "dev"
 Dynamic: license-file
 
 # figpack
@@ -68,19 +81,47 @@ 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)
+graph.show(open_in_browser=True, title="Quick Start Example")
 ```
 
+## Available Views
+
+figpack provides a comprehensive set of view components for creating interactive visualizations:
+
+### Core Views
+
+- **[TimeseriesGraph](docs/timeseries-graph.md)** - Interactive line plots, markers, and intervals ([example](examples/example_timeseries_graph.py))
+- **[MultiChannelTimeseries](docs/multichannel-timeseries.md)** - Multi-channel timeseries visualization ([example](examples/example_multichannel_timeseries.py))
+- **[Image](docs/image.md)** - Display images with optional annotations ([example](examples/example_image.py))
+- **[Markdown](docs/markdown.md)** - Render markdown content ([example](examples/example_markdown.py))
+
+### Layout Views
+
+- **[Box](docs/box.md)** - Flexible container with horizontal/vertical layouts ([example](examples/example_box.py))
+- **[Splitter](docs/splitter.md)** - Resizable split panes ([example](examples/example_splitter.py))
+- **[TabLayout](docs/tab-layout.md)** - Tabbed interface for multiple views ([example](examples/example_tablayout.py))
+
+### External Figure Support
+
+- **[MatplotlibFigure](docs/matplotlib-figure.md)** - Embed matplotlib plots ([example](examples/example_matplotlib.py))
+- **[PlotlyFigure](docs/plotly-figure.md)** - Embed plotly visualizations ([example](examples/example_plotly.py))
+
+### Spike Sorting Views
+
+- **[Autocorrelograms](docs/autocorrelograms.md)** - Auto-correlation analysis ([example](examples/example_autocorrelograms.py))
+- **[CrossCorrelograms](docs/cross-correlograms.md)** - Cross-correlation analysis ([example](examples/example_cross_correlograms.py))
+- **[UnitsTable](docs/units-table.md)** - Sortable table for spike sorting units ([example](examples/example_units_table.py))
+
 ## Examples
 
-See the `examples/` directory.
+See the `examples/` directory for working examples of each view type.
 
 ## Usage Modes
 
-### Local Development
+### Local-only Mode
 
 ```python
-view.show(open_in_browser=True)
+view.show(open_in_browser=True, title="Local Visualization")
 ```
 
 ### Sharing Online
@@ -88,12 +129,12 @@ view.show(open_in_browser=True)
 Set the `FIGPACK_UPLOAD_PASSCODE` environment variable and use:
 
 ```python
-view.show(upload=True, open_in_browser=True)
+view.show(upload=True, open_in_browser=True, title="Shared Visualization")
 ```
 
 ### Development Mode
 
-Set `_dev=True` in the call to show() to enable development mode, which allows for live updates and debugging with figpack-gui.
+Set `_dev=True` in the call to show() to enable development mode, which allows for live updates and development of figpack-gui.
 
 ## Command Line Interface
 

figpack-0.1.5/README.md

@@ -0,0 +1,123 @@
+# 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, title="Quick Start Example")
+```
+
+## Available Views
+
+figpack provides a comprehensive set of view components for creating interactive visualizations:
+
+### Core Views
+
+- **[TimeseriesGraph](docs/timeseries-graph.md)** - Interactive line plots, markers, and intervals ([example](examples/example_timeseries_graph.py))
+- **[MultiChannelTimeseries](docs/multichannel-timeseries.md)** - Multi-channel timeseries visualization ([example](examples/example_multichannel_timeseries.py))
+- **[Image](docs/image.md)** - Display images with optional annotations ([example](examples/example_image.py))
+- **[Markdown](docs/markdown.md)** - Render markdown content ([example](examples/example_markdown.py))
+
+### Layout Views
+
+- **[Box](docs/box.md)** - Flexible container with horizontal/vertical layouts ([example](examples/example_box.py))
+- **[Splitter](docs/splitter.md)** - Resizable split panes ([example](examples/example_splitter.py))
+- **[TabLayout](docs/tab-layout.md)** - Tabbed interface for multiple views ([example](examples/example_tablayout.py))
+
+### External Figure Support
+
+- **[MatplotlibFigure](docs/matplotlib-figure.md)** - Embed matplotlib plots ([example](examples/example_matplotlib.py))
+- **[PlotlyFigure](docs/plotly-figure.md)** - Embed plotly visualizations ([example](examples/example_plotly.py))
+
+### Spike Sorting Views
+
+- **[Autocorrelograms](docs/autocorrelograms.md)** - Auto-correlation analysis ([example](examples/example_autocorrelograms.py))
+- **[CrossCorrelograms](docs/cross-correlograms.md)** - Cross-correlation analysis ([example](examples/example_cross_correlograms.py))
+- **[UnitsTable](docs/units-table.md)** - Sortable table for spike sorting units ([example](examples/example_units_table.py))
+
+## Examples
+
+See the `examples/` directory for working examples of each view type.
+
+## Usage Modes
+
+### Local-only Mode
+
+```python
+view.show(open_in_browser=True, title="Local Visualization")
+```
+
+### Sharing Online
+
+Set the `FIGPACK_UPLOAD_PASSCODE` environment variable and use:
+
+```python
+view.show(upload=True, open_in_browser=True, title="Shared Visualization")
+```
+
+### Development Mode
+
+Set `_dev=True` in the call to show() to enable development mode, which allows for live updates and development of figpack-gui.
+
+## Command Line Interface
+
+figpack includes a command-line interface for working with figures:
+
+### Download a Figure
+
+```bash
+figpack download <figure-url> <dest.tar.gz>
+```
+
+Download a figure from any figpack URL and save it as a local archive.
+
+### View a Figure Archive
+
+```bash
+figpack view <figure.tar.gz>
+```
+
+Extract and view a figure archive in your browser. The server will run locally until you press Enter.
+
+Use `--port <number>` to specify a custom port.
+
+## License
+
+Apache-2.0
+
+## Contributing
+
+Visit the [GitHub repository](https://github.com/magland/figpack) for issues, contributions, and the latest updates.

figpack-0.1.5/figpack/__init__.py

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

{figpack-0.1.4 → figpack-0.1.5}/figpack/cli.py

@@ -3,19 +3,20 @@ Command-line interface for figpack
 """
 
 import argparse
-import sys
+import json
 import pathlib
-import tempfile
+import socket
+import sys
 import tarfile
-import json
-import requests
+import tempfile
 import threading
 import webbrowser
-import socket
 from concurrent.futures import ThreadPoolExecutor, as_completed
-from urllib.parse import urlparse, urljoin
-from typing import Dict, List, Tuple, Optional, Union
 from http.server import SimpleHTTPRequestHandler, ThreadingHTTPServer
+from typing import Dict, List, Optional, Tuple, Union
+from urllib.parse import urljoin, urlparse
+
+import requests
 
 from . import __version__
 from .core._show_view import serve_files

{figpack-0.1.4 → figpack-0.1.5}/figpack/core/_bundle_utils.py

@@ -1,6 +1,8 @@
 import os
 import pathlib
+
 import zarr
+
 from .figpack_view import FigpackView
 
 thisdir = pathlib.Path(__file__).parent.resolve()

{figpack-0.1.4 → figpack-0.1.5}/figpack/core/_show_view.py

@@ -1,18 +1,14 @@
 import os
-
-from typing import Union
-import tempfile
-
-import webbrowser
-
 import pathlib
-
+import tempfile
 import threading
+import webbrowser
 from http.server import SimpleHTTPRequestHandler, ThreadingHTTPServer
+from typing import Union
 
-from .figpack_view import FigpackView
 from ._bundle_utils import prepare_figure_bundle
 from ._upload_bundle import _upload_bundle
+from .figpack_view import FigpackView
 
 thisdir = pathlib.Path(__file__).parent.resolve()
 

{figpack-0.1.4 → figpack-0.1.5}/figpack/core/_upload_bundle.py

@@ -1,18 +1,20 @@
-import time
+import hashlib
 import json
-import uuid
 import pathlib
-import requests
 import threading
-import hashlib
-from .. import __version__
+import time
+import uuid
 from concurrent.futures import ThreadPoolExecutor, as_completed
 from datetime import datetime, timedelta, timezone
 
+import requests
+
+from .. import __version__
+
 thisdir = pathlib.Path(__file__).parent.resolve()
 
 FIGPACK_API_BASE_URL = "https://figpack-api.vercel.app"
-TEMPORY_BASE_URL = "https://tempory.net/figpack/default/figures"
+FIGPACK_FIGURES_BASE_URL = "https://figures.figpack.org/figures/default"
 
 
 def _upload_single_file(
@@ -78,7 +80,7 @@ def _check_existing_figure(figure_id: str) -> dict:
     Returns:
         dict: Contains 'exists' (bool) and 'status' (str) if exists
     """
-    figpack_url = f"{TEMPORY_BASE_URL}/{figure_id}/figpack.json"
+    figpack_url = f"{FIGPACK_FIGURES_BASE_URL}/{figure_id}/figpack.json"
 
     try:
         response = requests.get(figpack_url, timeout=10)
@@ -148,7 +150,7 @@ def _upload_bundle(tmpdir: str, passcode: str) -> None:
 
     # If figure_id is None, it means we found a completed upload and should skip
     if figure_id is None:
-        figure_url = f"{TEMPORY_BASE_URL}/{completed_figure_id}/index.html"
+        figure_url = f"{FIGPACK_FIGURES_BASE_URL}/{completed_figure_id}/index.html"
         print(f"Figure already exists at: {figure_url}")
         return figure_url
 
@@ -281,7 +283,7 @@ def _upload_bundle(tmpdir: str, passcode: str) -> None:
     )
     print("Upload completed successfully")
 
-    figure_url = f"{TEMPORY_BASE_URL}/{figure_id}/index.html"
+    figure_url = f"{FIGPACK_FIGURES_BASE_URL}/{figure_id}/index.html"
     return figure_url
 
 
@@ -352,7 +354,7 @@ def _upload_small_file(
     """
     Upload a small file by sending content directly
     """
-    destination_url = f"{TEMPORY_BASE_URL}/{figure_id}/{file_path}"
+    destination_url = f"{FIGPACK_FIGURES_BASE_URL}/{figure_id}/{file_path}"
 
     try:
         content.encode("utf-8")
@@ -386,7 +388,7 @@ def _upload_large_file(
     """
     Upload a large file using signed URL
     """
-    destination_url = f"{TEMPORY_BASE_URL}/{figure_id}/{file_path}"
+    destination_url = f"{FIGPACK_FIGURES_BASE_URL}/{figure_id}/{file_path}"
     file_size = local_file_path.stat().st_size
 
     # Get signed URL

{figpack-0.1.4 → figpack-0.1.5}/figpack/core/figpack_view.py

@@ -49,6 +49,7 @@ class FigpackView:
             print(
                 f"For development, run figpack-gui in dev mode and use http://localhost:5173?data=http://localhost:{port}/data.zarr"
             )
+            open_in_browser = False
 
         _show_view(
             self,