openplot 1.0.0__py3-none-any.whl

openplot-1.0.0.dist-info/METADATA

@@ -0,0 +1,332 @@
+Metadata-Version: 2.3
+Name: openplot
+Version: 1.0.0
+Summary: Makes plotting and fine-tuning plots easy and interactive.
+Author: Philo Wu
+Author-email: Philo Wu <philo.wu@codeboyphilo.ai>
+Requires-Dist: fastapi>=0.115.0
+Requires-Dist: uvicorn[standard]>=0.30.0
+Requires-Dist: websockets>=13.0
+Requires-Dist: click>=8.1.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: mcp>=1.26.0
+Requires-Dist: numpy>=2.4.2
+Requires-Dist: pandas>=3.0.1
+Requires-Dist: matplotlib>=3.10.8
+Requires-Dist: seaborn>=0.13.2
+Requires-Dist: openpyxl>=3.1.5
+Requires-Dist: pywebview>=5.2 ; sys_platform != 'linux' and extra == 'desktop'
+Requires-Dist: pywebview[qt]>=5.2 ; sys_platform == 'linux' and extra == 'desktop'
+Requires-Dist: pyobjc-core>=11.1 ; sys_platform == 'darwin' and extra == 'desktop'
+Requires-Dist: pyobjc-framework-cocoa>=11.1 ; sys_platform == 'darwin' and extra == 'desktop'
+Requires-Dist: pyobjc-framework-quartz>=11.1 ; sys_platform == 'darwin' and extra == 'desktop'
+Requires-Dist: pyobjc-framework-security>=11.1 ; sys_platform == 'darwin' and extra == 'desktop'
+Requires-Dist: pyobjc-framework-webkit>=11.1 ; sys_platform == 'darwin' and extra == 'desktop'
+Requires-Python: >=3.12
+Provides-Extra: desktop
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="frontend/openplot.png" alt="OpenPlot" width="520" />
+</p>
+
+<p align="center"><strong>The agentic plotting "IDE" built for everyone </strong></p>
+
+<p align="center">
+  <img alt="Python 3.12+" src="https://img.shields.io/badge/python-3.12%2B-3776AB?logo=python&logoColor=white" />
+  <img alt="License: GPL-3.0" src="https://img.shields.io/badge/license-GPL--3.0-blue" />
+  <img alt="Platform" src="https://img.shields.io/badge/platform-macOS%20%7C%20Linux%20%7C%20Windows-lightgrey" />
+</p>
+
+---
+
+Agentic coding already makes plotting easier: give your data to an agent, and it can write a script for you in seconds.
+But **getting a plot** is not the same as **getting a _good_ plot**.
+That first draft is usually not presentation-ready. Quite often, _it just looks bad_.
+
+So you spend the next 30 minutes telling the agent exactly what to change. Move the legend. Fix the labels. Soften the colours. Tighten the spacing. After a few rounds you finally feel like you are getting close -- and then comes **another 30 minutes of tiny adjustments**. Worse, sometimes you know _exactly_ what feels wrong, but cannot describe it clearly enough for the agent to act on it. You end up writing 100 words just to point at one awkward corner of the figure.
+
+**OpenPlot is built for that part.**
+It is an agentic plotting IDE that lets you stay in control **without babysitting the whole process**. Connect your favourite coding agent -- Codex, Claude Code, or OpenCode -- and let it inspect the data, choose the right visualisation, and handle styling, colour, layout, and positioning for you. In **Auto mode**, agents can review their own drafts and keep refining through multiple passes.
+OpenPlot turns painful prompting into a much simpler decision-making workflow: choose your data file, confirm a few design options, switch on **Auto mode**, and go make your coffee.
+
+<table align="center">
+  <tr>
+    <td align="center" width="50%">
+      <img src="assets/file-selection.gif" alt="OpenPlot file selection demo" width="100%" /><br />
+      <sub>Pick the data files you want the agent to work with.</sub>
+    </td>
+    <td align="center" width="50%">
+      <img src="assets/decide-plot-style.gif" alt="OpenPlot plot style selection demo" width="100%" /><br />
+      <sub>Confirm the deisgn choices and start plotting.</sub>
+    </td>
+  </tr>
+</table>
+
+And when the result is _98% right_ but still not quite there, OpenPlot's **drag-and-select annotation mode** makes the last mile easy. Just point to the exact region you want fixed and describe the change in simple, lazy language. **No prompt engineering.** No carefully crafted essay. Just direct instruction.
+
+<table align="center">
+  <tr>
+    <td align="center" width="50%">
+      <img src="assets/make-annotation.gif" alt="OpenPlot annotation demo" width="100%" /><br />
+      <sub>Drag-select the exact region you want changed.</sub>
+    </td>
+    <td align="center" width="50%">
+      <img src="assets/fix-annotations.gif" alt="OpenPlot annotation fix demo" width="100%" /><br />
+      <sub>Watch live output from the agent addressing your comment.</sub>
+    </td>
+  </tr>
+</table>
+
+If you want to explore multiple directions, OpenPlot makes that easy too. Click any previous step, make any new annotation to branch from it, and try a different adjustment path in parallel. OpenPlot gives you **git-like version control for plots**: switch between branches, compare outcomes, and download both the final image _and_ the directly runnable Python script behind it.
+
+OpenPlot also ships with a **built-in Python runtime** and popular data visualisation libraries. Need more? Configure your own environment.
+
+We want OpenPlot to be **truly for everyone**.
+
+## Features
+
+**Plot Mode** -- Generate plots from local data files through an AI chat interface. Select file paths, preview supported tabular sources, confirm target ranges when needed, approve a plan, and let the agent produce a plotting script autonomously.
+
+**Annotation Mode** -- Draw and select regions on rendered plot, attach lazy instruction, and let a coding agent fix it precisely.
+
+**Feedback Compiler** -- Annotations are turned into structured LLM prompts with scope rules (local region vs. local element) so the model knows exactly what to change.
+
+**MCP Server** -- Built-in MCP bridge for agent integration via `openplot mcp`, with automatic wiring for supported runners.
+
+**Multi-Runner Support** -- Connect with your favourite agents [OpenCode](https://opencode.ai), [Codex](https://github.com/openai/codex), or [Claude Code](https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/overview) as the fixing agent, with per-runner model and variant selection.
+
+**Version Control** -- Every fix creates a new version with immutable script and plot snapshots. Supports undo and branching to compare between versions.
+
+**Background Fix Jobs** -- Kick off repeated fix iterations from the UI and watch live runner output until all pending annotations are addressed.
+
+**Desktop App** -- Native desktop app via pywebview on macOS and Windows.
+
+**Data Privacy** -- OpenPlot keeps scripts, plots, and session state on your machine. Remote network usage depends on the coding runner and model you connect.
+
+**Data Profiling** -- Auto-detects table regions in tabular data, shows previews with integrity notes, and supports multi-sheet Excel workbooks.
+
+## Roadmap
+
+- [ ] Support bring-your-own API key
+- [ ] Plugin for jupyter lab
+- [ ] Integrate with NanoBanana
+
+## Installation
+
+### Prerequisites
+
+OpenPlot needs a coding agent CLI to generate and fix plots. You must have **at least one** of the following installed:
+
+| Agent       | Install guide                                                                                    |
+| ----------- | ------------------------------------------------------------------------------------------------ |
+| OpenCode    | [docs](https://opencode.ai)                                                                      |
+| Codex       | [docs](https://chatgpt.com/codex)                                                                |
+| Claude Code | [docs](https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/overview#getting-started) |
+
+> **macOS desktop app users:** The `.dmg` build bundles a one-click installer for coding agents, so you can skip this step and set up an agent from within the app.
+
+### Pre-Built Binaries
+
+Current GitHub release artifacts are available from [GitHub Releases](https://github.com/phira-ai/OpenPlot/releases):
+
+| Platform               | Artifact                   |
+| ---------------------- | -------------------------- |
+| macOS (M-chip) (arm64) | `OpenPlot-arm64.dmg`       |
+| Windows (x64)          | `OpenPlot-windows-x64.zip` |
+
+Linux users can build from source or use the Nix flake.
+
+### From PyPI
+
+```bash
+pip install openplot
+```
+
+To include desktop app dependencies (pywebview):
+
+```bash
+pip install "openplot[desktop]"
+```
+
+### From Source
+
+**Prerequisites:** Python 3.12+, [uv](https://docs.astral.sh/uv/), Node.js + npm
+
+```bash
+git clone https://github.com/phira-ai/OpenPlot.git
+cd OpenPlot
+uv sync
+npm ci --prefix frontend
+npm run build --prefix frontend
+```
+
+To include desktop app dependencies (pywebview):
+
+```bash
+uv sync --extra desktop
+```
+
+To include development tools (ruff, pytest):
+
+```bash
+uv sync --group dev
+```
+
+### Nix Flake
+
+```bash
+# Run directly
+nix run github:phira-ai/OpenPlot#openplot -- serve examples/test_plot.py
+
+# Run the desktop launcher
+nix run github:phira-ai/OpenPlot#openplot-desktop
+
+# Build the package
+nix build github:phira-ai/OpenPlot#openplot
+```
+
+Use as a flake input:
+
+```nix
+{
+  inputs.openplot.url = "github:phira-ai/OpenPlot";
+}
+```
+
+and
+
+```nix
+  environment.systemPackages = with pkgs; [
+    inputs.openplot.packages.${pkgs.stdenv.hostPlatform.system}.openplot
+    inputs.openplot.packages.${pkgs.stdenv.hostPlatform.system}.openplot-desktop
+  ];
+```
+
+## Architecture
+
+```
+┌─────────────────────────────────────────────────────┐
+│                    Web UI (React)                   │
+│  Plot Viewer  ·  Annotation Overlay  ·  Chat Panel  │
+└──────────────────────┬──────────────────────────────┘
+                       │ REST + WebSocket
+┌──────────────────────▼──────────────────────────────┐
+│                FastAPI Backend (Python)             │
+│  Script Executor · Feedback Compiler · Session Mgr  │
+│  Version Control · Data Profiler · Fix Job Runner   │
+└──────────┬────────────────────────────┬─────────────┘
+           │ stdio (MCP)                │ subprocess
+┌──────────▼───────────┐    ┌───────────▼─────────────┐
+│     Coding Agent     │    │   Python Interpreter    │
+│ (OpenCode / Codex /  │    │  (matplotlib, seaborn,  │
+│   Claude Code)       │    │   numpy, pandas, ...)   │
+└──────────────────────┘    └─────────────────────────┘
+```
+
+1. The **React frontend** renders plots and captures region annotations.
+2. The **FastAPI backend** compiles annotations into structured prompts, executes scripts, manages versioned state, and serves everything over REST and WebSocket.
+3. The **MCP server** bridges the backend to coding agents over stdio, enabling a closed feedback loop: annotate, fix, re-render, repeat.
+
+<details>
+<summary><strong>CLI Reference</strong></summary>
+
+### `openplot serve`
+
+Start the OpenPlot backend/UI server and open the browser by default.
+
+```
+openplot serve [FILE] [OPTIONS]
+```
+
+| Option         | Default     | Description                          |
+| -------------- | ----------- | ------------------------------------ |
+| `FILE`         | _(none)_    | Python script (`.py`)                |
+| `--port`       | `17623`     | Server port (`0` for auto-pick)      |
+| `--host`       | `127.0.0.1` | Bind address                         |
+| `--no-browser` | off         | Don't open the browser automatically |
+
+When `FILE` is omitted, OpenPlot restores the most recently updated workspace. If no workspace exists, it launches in plot mode.
+
+### `openplot desktop`
+
+Launch the native desktop window.
+
+```
+openplot desktop [FILE] [OPTIONS]
+```
+
+Accepts the same `.py` `FILE` input and the same options as `serve` except `--no-browser`.
+
+### `openplot mcp`
+
+Start the MCP stdio bridge for agent integration.
+
+```
+openplot mcp [OPTIONS]
+```
+
+| Option         | Default             | Description          |
+| -------------- | ------------------- | -------------------- |
+| `--server-url` | _(auto-discovered)_ | OpenPlot backend URL |
+
+Server URL discovery priority: `--server-url` > `OPENPLOT_SERVER_URL` > `~/.openplot/port`.
+
+`openplot serve` does not launch the MCP stdio bridge itself; it writes the discovery port file used by `openplot mcp`. In normal OpenPlot runner flows, supported agents launch `openplot mcp` automatically when they need MCP access.
+
+</details>
+
+<details>
+<summary><strong>Configuration</strong></summary>
+
+### Environment Variables
+
+| Variable                  | Description                                               |
+| ------------------------- | --------------------------------------------------------- |
+| `OPENPLOT_STATE_DIR`      | Override the runtime state/artifacts root                 |
+| `OPENPLOT_SERVER_URL`     | MCP only: override the backend URL used by `openplot mcp` |
+| `OPENPLOT_SESSION_ID`     | MCP only: target a specific session in MCP calls          |
+| `OPENPLOT_BUILTIN_PYTHON` | Advanced: override the built-in Python interpreter path   |
+
+Selected data files stay at their original paths; OpenPlot no longer copies them into an app-managed data store.
+
+### State Storage Paths
+
+| Platform | State                                           |
+| -------- | ----------------------------------------------- |
+| macOS    | `~/Library/Application Support/OpenPlot/state/` |
+| Linux    | `~/.local/state/openplot/`                      |
+| Windows  | `%LOCALAPPDATA%/OpenPlot/state/`                |
+
+</details>
+
+## Contributing
+
+Contributions are welcome. To get started:
+
+```bash
+# Clone and install with dev dependencies
+git clone https://github.com/phira-ai/OpenPlot.git
+cd OpenPlot
+uv sync --group dev
+
+# Install frontend dependencies
+npm ci --prefix frontend
+
+# Run backend checks
+uv run pytest
+uv run ruff check src tests
+
+# Run frontend checks
+npm run test --prefix frontend
+npm run lint --prefix frontend
+
+# Build frontend (includes TypeScript build)
+npm run build --prefix frontend
+```
+
+Please open an issue before submitting large changes.
+
+## License
+
+This project is licensed under the [GNU General Public License v3.0](LICENSE).

openplot-1.0.0.dist-info/RECORD

@@ -0,0 +1,34 @@
+openplot/__init__.py,sha256=nUJ1I3CPbQ-f0MJ991fkSk-V0CWkhDF7LUg6OGdLDEQ,61
+openplot/api/__init__.py,sha256=chpbPDwFF-66YsGOSuPr9U99hfDN_hZn5QGpgLttSAI,44
+openplot/api/schemas.py,sha256=L78fLgcJQaLWn27PWXeCsZ1TpWcjR36k0vp8sfLg_tc,3088
+openplot/cli.py,sha256=Iy-4RaFIuObadZpi2k150maXJwHC2P0FVhD1nMtJmxo,4092
+openplot/desktop.py,sha256=loBRlK60K5B6A2mL1yH_TpI-N1iyCLFn2CFimyHllco,12387
+openplot/domain/__init__.py,sha256=g_pEHlyIPL9BMzVoHeDeKkU052c3Ygpbwvkct5qiuBA,42
+openplot/domain/annotations.py,sha256=tVjACUhJGWAbfa6qa1RKviwnnkggDHWiCO_DXFDGWx0,1442
+openplot/domain/regions.py,sha256=a1DJRdlpxYLh4NplZJ2rzSCGnyEq8FEASogvFekwW2g,1496
+openplot/executor.py,sha256=jbvx8ofbILyt0PBuEBUVH-xY8WLVwtQ-M9VbWvHfohA,22735
+openplot/feedback.py,sha256=goaT4iNAGW_-QpZPv96R6foXUeXtql2dT3d95JbHZ1k,5098
+openplot/mcp_server.py,sha256=_qIBl7A826BZfHaNgpLGEyr0Bv76gqcUIw7e_Hxt_L8,13431
+openplot/models.py,sha256=eK-HmSBchrd4VuyB7-m9436yacmihazamXBcbh1xv6k,12715
+openplot/release_versioning.py,sha256=a4fFyftMIxdwOf8bmRKdozXOXTgBMJD455OIEYio8i8,10443
+openplot/server.py,sha256=Fz0tfSqbeMm3bc-vwAXS8r58ecShQbbjP66_McISpbw,378840
+openplot/services/__init__.py,sha256=66n5YXVZWuGkYZy6z7W47-MFDOEqYaz457tu9XDiazk,51
+openplot/services/naming.py,sha256=fbHrWqYldd8MbXRu7pXkydYWhZ_8w7ZCT_pQtr9-uK0,1948
+openplot/static/assets/MarkdownRenderer-DqMDEmDw.js,sha256=U0VLANaqcsGCfEDGychawl-n1Xx0zJX9ikUkhgTyDIs,1824
+openplot/static/assets/geist-cyrillic-wght-normal-CHSlOQsW.woff2,sha256=M9erRg3_Th_FhnONXVDj4EvLSOm-97lBVMx-B67ta2Y,14692
+openplot/static/assets/geist-latin-ext-wght-normal-DMtmJ5ZE.woff2,sha256=NkD5NRsqRjFRXf_qOAksJOcNud8u8el8EMvetBY-YYY,15308
+openplot/static/assets/geist-latin-wght-normal-Dm3htQBi.woff2,sha256=DLvmKGoA81bpiYB4PMlQqbaTdR4Ert-5fZUm_23CsxY,28400
+openplot/static/assets/iconify-xdk4cov8.js,sha256=KJvUYwkDupzYPEx4wvzUCqmD82hfaDWgoUwyNEN6fEw,41429
+openplot/static/assets/index-9qrwxLoh.css,sha256=bkPKEfEUa8LYf_vWrFGcRJH1_JTJiZMcWnrIYHuFGts,111020
+openplot/static/assets/index-DhwX5yIi.js,sha256=ZW4YpPQulzKXWFQNV1PkT-htIuq4SYI8Vsck70pw1UA,218344
+openplot/static/assets/lucide-DCaNFHhh.js,sha256=iJ1J1yhgJ7gbo9zDSqtnXOtoUR8Hr001D54GeueqvAY,8388
+openplot/static/assets/markdown-BgYhP8km.js,sha256=fymO8mwu_tLDEqo5sJv_rcyRQbkOQlalzUG6xKRCtjI,156615
+openplot/static/assets/openplot-DYqSIMi_.png,sha256=aqNUyTLR6ZMQXxT_Hpf18Hgl_gAi8rsnuD8wBaF6Wk4,16847
+openplot/static/assets/react-vendor-C4hNv3Lv.js,sha256=pmYsFfFCH55lEsGbkgnlSlcRgNzmlmpiAyUJTm05PxU,192906
+openplot/static/assets/ui-DjPaK12C.js,sha256=Rfi5kHmKLCOTokb2JQq4IPptKewcfDQsv3NiKadBSc4,135829
+openplot/static/index.html,sha256=QPx92GiOAk2vA8AJzveFfusMEAwGqwTyrvcudtw_zgg,704
+openplot/static/vite.svg,sha256=SnSK_UQ5GLsWWRyDTEAdrjPoeGGrXbrQgRw6O0qSFPs,1497
+openplot-1.0.0.dist-info/WHEEL,sha256=GuAqCqoyQuys5_R4zkHUJFlKXw4RpRLNzo31-ui90WQ,81
+openplot-1.0.0.dist-info/entry_points.txt,sha256=mSIPtPJXyADeYzDT3A4MbdFdZn_CmpjD6udLfQOyrQQ,89
+openplot-1.0.0.dist-info/METADATA,sha256=imh-4483ZqKu3hGu87-rSALCDOEUSaZnfcFLXKy7JuY,14495
+openplot-1.0.0.dist-info/RECORD,,

openplot-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.10.12
+Root-Is-Purelib: true
+Tag: py3-none-any

openplot-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,4 @@
+[console_scripts]
+openplot = openplot.cli:main
+openplot-desktop = openplot.desktop:main
+