kaxe 1.8.1.dev2__tar.gz → 1.8.1.dev4__tar.gz

{kaxe-1.8.1.dev2/src/kaxe.egg-info → kaxe-1.8.1.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kaxe
-Version: 1.8.1.dev2
+Version: 1.8.1.dev4
 Summary: A small graphing tool for functions, points, equations and more
 Author-email: Valter Yde Daugberg <valteryde@hotmail.com>
 Project-URL: Homepage, https://github.com/valteryde/kaxe
@@ -44,9 +44,9 @@ Documentation: [kaxe.readthedocs.io](https://kaxe.readthedocs.io/en/latest/)
 
 ```bash
 pip install kaxe          # 2D plotting (default)
-pip install kaxe[3d]        # add 3D plotting (OpenGL)
-pip install kaxe[pdf]       # add PDF export
-pip install kaxe[3d,pdf]    # 3D + PDF
+pip install kaxe[viewer]  # add interactive desktop viewer (pyglet)
+pip install kaxe[3d]      # add 3D plotting (OpenGL)
+pip install kaxe[pdf]     # add PDF export
 ```
 
 ## Quick example
@@ -59,10 +59,45 @@ plt.add(kaxe.Function2D(lambda x: x**2 - 4))
 plt.add(kaxe.Points2D([1, 2, 3], [1, 4, 9]))
 plt.theme(kaxe.Themes.A4Medium)
 plt.title("$x^2 - 4$")
+plt.show()                # streams to viewer if open, or opens system viewer
 plt.save("figure.png")
 plt.save("figure.svg")
 ```
 
+## Interactive Plot Viewer (Infinite Canvas)
+
+Kaxe includes a dedicated, lightweight OpenGL workspace powered by [pyglet](https://pyglet.org) so you can arrange, inspect, and compare multiple plots on an infinite canvas without cluttering your desktop with preview windows.
+
+1. **Start the viewer** in a terminal:
+   ```bash
+   kaxe viewer
+   ```
+2. **Tag and show your plots**:
+   ```python
+   # Tag plots with an ID to manage them on the board:
+   plt1 = kaxe.Plot().id("loss").title("Training Loss")
+   plt1.show()
+
+   plt2 = kaxe.Plot().id("accuracy").title("Validation Accuracy")
+   plt2.show()
+   ```
+
+When the viewer is open, `.show()` instantly streams plots to cards on your canvas. If you re-run code with the same ID, the card updates in-place and preserves previous runs as versions (`v1`, `v2`, etc.). If the viewer is closed, `.show()` automatically falls back to your operating system's default viewer.
+
+**Canvas & Card Controls:**
+* **Click & Drag on a Card**: Move that card freely across the canvas
+* **Click & Drag on Empty Space**: Pan the camera across the workspace
+* **Mouse Scroll**: Smooth zoom anchored to cursor
+* **`[A]`**: Auto-arrange all cards in a neat row
+* **`[Space]` or `[R]`**: Fit all cards on the canvas into view
+* **`[1]`**: View canvas at 100% native pixel scale
+* **`[←]` / `[→]`**: Cycle through versions (`v1`, `v2`, ...) of the selected card
+* **`[Backspace]` / `[Delete]`**: Remove the selected card from the board
+* **`[C]`** *(or Cmd/Ctrl+C)*: Copy selected plot to system clipboard
+* **`[S]`** *(or Cmd/Ctrl+S)*: Save selected plot to timestamped PNG
+* **`[H]`**: Toggle status & shortcuts HUD
+
+
 See the [getting started guide](https://kaxe.readthedocs.io/en/latest/pages/start.html), [recipes](https://kaxe.readthedocs.io/en/latest/pages/recipes.html), [styling guide](https://kaxe.readthedocs.io/en/latest/pages/styling.html), and [export guide](https://kaxe.readthedocs.io/en/latest/pages/export.html) for the full API.
 
 ## Goals

kaxe-1.8.1.dev4/README.md

@@ -0,0 +1,88 @@
+
+# Kaxe
+
+![BoxPlot](logo.png)
+
+Kaxe is a lightweight, pure-Python plotting library for publication-quality figures in LaTeX documents. Create plots and charts with a simple object-oriented API, style them for A4 pages, and export to PNG or SVG.
+
+Documentation: [kaxe.readthedocs.io](https://kaxe.readthedocs.io/en/latest/)
+
+## Installation
+
+```bash
+pip install kaxe          # 2D plotting (default)
+pip install kaxe[viewer]  # add interactive desktop viewer (pyglet)
+pip install kaxe[3d]      # add 3D plotting (OpenGL)
+pip install kaxe[pdf]     # add PDF export
+```
+
+## Quick example
+
+```python
+import kaxe
+
+plt = kaxe.Plot([-5, 5, -5, 5])
+plt.add(kaxe.Function2D(lambda x: x**2 - 4))
+plt.add(kaxe.Points2D([1, 2, 3], [1, 4, 9]))
+plt.theme(kaxe.Themes.A4Medium)
+plt.title("$x^2 - 4$")
+plt.show()                # streams to viewer if open, or opens system viewer
+plt.save("figure.png")
+plt.save("figure.svg")
+```
+
+## Interactive Plot Viewer (Infinite Canvas)
+
+Kaxe includes a dedicated, lightweight OpenGL workspace powered by [pyglet](https://pyglet.org) so you can arrange, inspect, and compare multiple plots on an infinite canvas without cluttering your desktop with preview windows.
+
+1. **Start the viewer** in a terminal:
+   ```bash
+   kaxe viewer
+   ```
+2. **Tag and show your plots**:
+   ```python
+   # Tag plots with an ID to manage them on the board:
+   plt1 = kaxe.Plot().id("loss").title("Training Loss")
+   plt1.show()
+
+   plt2 = kaxe.Plot().id("accuracy").title("Validation Accuracy")
+   plt2.show()
+   ```
+
+When the viewer is open, `.show()` instantly streams plots to cards on your canvas. If you re-run code with the same ID, the card updates in-place and preserves previous runs as versions (`v1`, `v2`, etc.). If the viewer is closed, `.show()` automatically falls back to your operating system's default viewer.
+
+**Canvas & Card Controls:**
+* **Click & Drag on a Card**: Move that card freely across the canvas
+* **Click & Drag on Empty Space**: Pan the camera across the workspace
+* **Mouse Scroll**: Smooth zoom anchored to cursor
+* **`[A]`**: Auto-arrange all cards in a neat row
+* **`[Space]` or `[R]`**: Fit all cards on the canvas into view
+* **`[1]`**: View canvas at 100% native pixel scale
+* **`[←]` / `[→]`**: Cycle through versions (`v1`, `v2`, ...) of the selected card
+* **`[Backspace]` / `[Delete]`**: Remove the selected card from the board
+* **`[C]`** *(or Cmd/Ctrl+C)*: Copy selected plot to system clipboard
+* **`[S]`** *(or Cmd/Ctrl+S)*: Save selected plot to timestamped PNG
+* **`[H]`**: Toggle status & shortcuts HUD
+
+
+See the [getting started guide](https://kaxe.readthedocs.io/en/latest/pages/start.html), [recipes](https://kaxe.readthedocs.io/en/latest/pages/recipes.html), [styling guide](https://kaxe.readthedocs.io/en/latest/pages/styling.html), and [export guide](https://kaxe.readthedocs.io/en/latest/pages/export.html) for the full API.
+
+## Goals
+
+Kaxe was made to create simple, aesthetic graphs for articles, reports, and other academic work in LaTeX:
+
+* Plots that fit the look of LaTeX documents (Computer Modern math via [fondi](https://github.com/valteryde/fondi))
+* A straightforward object-oriented interface: create a window, add objects, style, save
+
+## Examples of plots
+
+![BoxPlot](tests/images/boxed.png)
+![Polar plot](tests/images/polar.png)
+![PrettyPlot3D2](tests/images/3d-function-pretty-2.png)
+![Contour grid](tests/images/contourgrid.png)
+![Contour same](tests/images/contour3d.png)
+![AllLegends](tests/images/vectorimagearrow3d.png)
+![Functions](tests/images/function.png)
+![Points](tests/images/labels.png)
+![Equations](tests/images/equation.png)
+![Globallight](tests/images/lightfunction3d.png)

{kaxe-1.8.1.dev2 → kaxe-1.8.1.dev4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "kaxe"
-version = "1.8.1.dev2"
+version = "1.8.1.dev4"
 authors = [
   { name="Valter Yde Daugberg", email="valteryde@hotmail.com" },
 ]

{kaxe-1.8.1.dev2 → kaxe-1.8.1.dev4}/src/kaxe/core/window.py

@@ -647,25 +647,54 @@ class Window(AttrObject):
             logging.info('Total time to save {}s'.format(str(round(time.time() - totStartTime, 4))))
     
     
-    def show(self):
+    def id(self, plot_id: str):
+        """Assign a persistent identifier to this plot for the Kaxe Viewer."""
+        self.plot_id = str(plot_id)
+        return self
+
+    def show(self, id: Optional[str] = None):
         """
-        Show the current image using `Pillow.Image.Show`
+        Show the current image using `Pillow.Image.Show` or the Kaxe Viewer.
         
         If a cached image is available, it will be used to save the file.
         Otherwise, the image will be generated and then saved.
 
+        Parameters
+        ----------
+        id : str, optional
+            Identifier for this plot when sent to the Kaxe Viewer canvas.
+
         Examples
         --------
-        >>> plt.show( )
+        >>> plt.show()
+        >>> plt.show(id="my_graph_1")
         """
+        if id is not None:
+            self.plot_id = str(id)
+
         data = to_png_bytes(self)
         if is_notebook():
             display_png_bytes(data)
-        elif try_show_in_viewer(data, title=getattr(self, "titleText", "")):
+        elif try_show_in_viewer(
+            data,
+            title=getattr(self, "titleText", ""),
+            plot_id=getattr(self, "plot_id", None),
+        ):
             return
         else:
             Image.open(BytesIO(data)).show()
 
+    def open(self, id: Optional[str] = None):
+        """
+        Show the current image or stream to viewer (alias for show()).
+
+        Examples
+        --------
+        >>> plt.open()
+        >>> plt.open(id="my_graph_1")
+        """
+        return self.show(id=id)
+
     def _repr_png_(self):
         if not is_notebook():
             return None

{kaxe-1.8.1.dev2 → kaxe-1.8.1.dev4}/src/kaxe/plot/d3/plot3d.py

@@ -547,6 +547,10 @@ class Plot3D(Plot3DAxesMixin, Window):
         else:
             self.save(None).show()
 
+    def open(self, gui=True):
+        """Show the current plot (alias for show())."""
+        return self.show(gui=gui)
+
     def title(self, firstAxis=None, secondAxis=None, thirdAxis=None):
         """
         Adds title to the plot.

{kaxe-1.8.1.dev2 → kaxe-1.8.1.dev4}/src/kaxe/plot/grid.py

@@ -490,25 +490,54 @@ class Grid(AttrObject):
             img.save(fname, format="png")
 
 
-    def show(self):
+    def id(self, plot_id: str):
+        """Assign a persistent identifier to this grid for the Kaxe Viewer."""
+        self.plot_id = str(plot_id)
+        return self
+
+    def show(self, id: Optional[str] = None):
         """
-        Show the current image using `Pillow.Image.Show`
+        Show the current image using `Pillow.Image.Show` or the Kaxe Viewer.
         
         If a cached image is available, it will be used to save the file.
         Otherwise, the image will be generated and then saved.
 
+        Parameters
+        ----------
+        id : str, optional
+            Identifier for this grid when sent to the Kaxe Viewer canvas.
+
         Examples
         --------
-        >>> plt.show( )
+        >>> grid.show()
+        >>> grid.show(id="my_grid_1")
         """
+        if id is not None:
+            self.plot_id = str(id)
+
         data = to_png_bytes(self)
         if is_notebook():
             display_png_bytes(data)
-        elif try_show_in_viewer(data, title="Grid"):
+        elif try_show_in_viewer(
+            data,
+            title="Grid",
+            plot_id=getattr(self, "plot_id", None),
+        ):
             return
         else:
             Image.open(BytesIO(data)).show()
 
+    def open(self, id: Optional[str] = None):
+        """
+        Show the current grid or stream to viewer (alias for show()).
+
+        Examples
+        --------
+        >>> grid.open()
+        >>> grid.open(id="my_grid_1")
+        """
+        return self.show(id=id)
+
     def _repr_png_(self):
         if not is_notebook():
             return None

{kaxe-1.8.1.dev2 → kaxe-1.8.1.dev4}/src/kaxe/viewer/client.py

@@ -46,6 +46,7 @@ def is_viewer_active(port: Optional[int] = None, timeout: float = 0.03) -> bool:
 def send_to_viewer(
     data: bytes,
     title: str = "",
+    plot_id: Optional[str] = None,
     port: Optional[int] = None,
     timeout: float = 2.0,
 ) -> bool:
@@ -58,9 +59,11 @@ def send_to_viewer(
 
     url = f"http://127.0.0.1:{port}/show"
     safe_title = urllib.parse.quote(title or "")
+    safe_id = urllib.parse.quote(plot_id or "")
     headers = {
         "Content-Type": "image/png",
         "X-Kaxe-Title": safe_title,
+        "X-Kaxe-Id": safe_id,
     }
 
     req = urllib.request.Request(url, data=data, headers=headers, method="POST")
@@ -71,12 +74,18 @@ def send_to_viewer(
         return False
 
 
-def try_show_in_viewer(data: bytes, title: str = "") -> bool:
+def try_show_in_viewer(
+    data: bytes,
+    title: str = "",
+    plot_id: Optional[str] = None,
+) -> bool:
     """Convenience helper: probe port and send image if viewer is alive.
 
     Returns True if sent to viewer, False if fallback is needed.
     """
     port = get_viewer_port()
     if is_viewer_active(port):
-        return send_to_viewer(data, title=title, port=port)
+        if send_to_viewer(data, title=title, plot_id=plot_id, port=port):
+            print("[Kaxe] Plot streamed to viewer", flush=True)
+            return True
     return False

{kaxe-1.8.1.dev2 → kaxe-1.8.1.dev4}/src/kaxe/viewer/server.py

@@ -40,9 +40,13 @@ class PlotRequestHandler(BaseHTTPRequestHandler):
             raw_title = self.headers.get("X-Kaxe-Title", "")
             title = urllib.parse.unquote(raw_title) if raw_title else ""
 
+            raw_id = self.headers.get("X-Kaxe-Id", "")
+            plot_id = urllib.parse.unquote(raw_id) if raw_id else ""
+
             item: Dict[str, Any] = {
                 "data": img_bytes,
                 "title": title,
+                "plot_id": plot_id,
             }
             self.plot_queue.put(item)