Metadata-Version: 2.4
Name: figstudio
Version: 0.3.0
Summary: A local figure-workflow tool for reproducible, publication-ready Matplotlib panels.
Project-URL: Homepage, https://github.com/Isabelle20070607/figstudio
Project-URL: Documentation, https://github.com/Isabelle20070607/figstudio#readme
Project-URL: Source, https://github.com/Isabelle20070607/figstudio
Project-URL: Issues, https://github.com/Isabelle20070607/figstudio/issues
License: MIT License
        
        Copyright (c) 2026 FigStudio contributors
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: figures,matplotlib,plotting,scientific-python,visualization
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: FastAPI
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.11
Requires-Dist: fastapi>=0.115
Requires-Dist: matplotlib>=3.8
Requires-Dist: numpy>=1.26
Requires-Dist: pandas>=2.1
Requires-Dist: pydantic>=2.7
Requires-Dist: uvicorn[standard]>=0.30
Provides-Extra: dev
Requires-Dist: httpx2>=2.4.0; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Description-Content-Type: text/markdown

# FigStudio

FigStudio is a local-first figure workflow for scientific Python users who want to turn data already present in a script or notebook into polished, reproducible Matplotlib panels.

It opens a browser editor from your Python process, lets you map live variables to plot layers or statistics recipes, previews through Matplotlib, exports publication files, and saves plain Matplotlib OO code back to a controlled script block or notebook cell.

## Install

```powershell
pip install figstudio
```

The wheel includes the React editor. End users do not need Node, npm, Vite, or the frontend source tree after installation.

## Try It

```powershell
figstudio demo
```

For a script, add FigStudio after data preparation and give generated plotting code one controlled block:

```python
import figstudio

# Prepare data first.
session = figstudio.open(locals(), script_path=__file__, block_id="main")

# figstudio:start main
# figstudio:end main
```

In the editor, choose a live variable, add a plot layer or statistics recipe, polish the figure, export PNG/SVG/PDF, then click **Save code**.

## Documentation

| Language | Start here |
| --- | --- |
| English | [docs/en/index.md](docs/en/index.md) |
| Chinese / 中文 | [docs/zh/index.md](docs/zh/index.md) |

Common entry points:

| Reader | English | 中文 |
| --- | --- | --- |
| Figure users | [Get Started](docs/en/getting-started.md) | [快速开始](docs/zh/getting-started.md) |
| Scientific workflows | [Workflows](docs/en/scientific-workflows.md) | [科研制图工作流](docs/zh/scientific-workflows.md) |
| API consumers | [API Reference](docs/en/reference/api.md) | [API 参考](docs/zh/reference/api.md) |
| Contributors | [Developer Guide](docs/en/contributing/developer-guide.md) | [开发者指南](docs/zh/contributing/developer-guide.md) |

## Development

```powershell
uv run --extra dev pytest
cd frontend
npm install
npm run build
npm run dev
```

Build a publishable package:

```powershell
uv build
```

The build hook bundles the frontend into the Python wheel. Runtime installs from a built wheel still use the packaged editor and do not require frontend tooling.
