FlowPlotPy 0.9.0__cp312-cp312-win32.whl

flowplot/__init__.py

@@ -0,0 +1,22 @@
+from importlib import resources
+
+from . import _flowplot
+from ._flowplot import Plot, getCompleteJson, get_complete_json
+
+
+def _default_font_resource():
+    return resources.files(__package__).joinpath("fonts", "Inter.ttf")
+
+
+def plot(path):
+    plot_obj = _flowplot.plot(path)
+    with resources.as_file(_default_font_resource()) as font_path:
+        plot_obj.set_default_font(str(font_path))
+    return plot_obj
+
+__all__ = [
+    "Plot",
+    "getCompleteJson",
+    "get_complete_json",
+    "plot",
+]

flowplotpy-0.9.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Manwe314
+
+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.

flowplotpy-0.9.0.dist-info/METADATA

@@ -0,0 +1,336 @@
+Metadata-Version: 2.2
+Name: FlowPlotPy
+Version: 0.9.0
+Summary: Python bindings for the FlowPlot plotting library
+Author: FlowPlot contributors
+License: MIT License
+         
+         Copyright (c) 2026 Manwe314
+         
+         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.
+         
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: C++
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.10
+Provides-Extra: numpy
+Requires-Dist: numpy>=1.23; extra == "numpy"
+Description-Content-Type: text/markdown
+
+# FlowPlot
+
+FlowPlot is a header-only plotting library that:
+
+- compiles a JSON template into an internal spec
+- binds runtime data (`withData("dataset.field", ...)`)
+- resolves layout/axes/layers into a render command stream
+- optionally rasterizes to PNG with the built-in CPU renderer
+
+It supports scatter and histogram layers, automatic axis-domain inference, legends/titles, and pluggable text measurement/layout through `ITextEngine`.
+Text styling supports font family, numeric weight, and style (`normal`, `italic`, `oblique`).
+
+## Quick Start
+
+### 1. Create a template (`ScatterTemplate.json`)
+
+```json
+{
+  "version": "1.0",
+  "fonts": [
+    {
+      "family": "Inter",
+      "weight": 400,
+      "style": "normal",
+      "path": "/absolute/path/to/Inter-Regular.ttf"
+    },
+    {
+      "family": "Inter",
+      "weight": 700,
+      "style": "normal",
+      "path": "/absolute/path/to/Inter-Bold.ttf"
+    }
+  ],
+  "figure": {
+    "width": 1200,
+    "height": 800,
+    "title": {
+      "visible": true,
+      "text": "Scatter Plot",
+      "fontFamily": "Inter",
+      "fontWeight": 700,
+      "fontStyle": "normal"
+    }
+  },
+  "datasets": [
+    {
+      "name": "main",
+      "schema": {
+        "x": "number",
+        "y": "number"
+      }
+    }
+  ],
+  "panels": [
+    {
+      "layers": [
+        {
+          "type": "scatter",
+          "dataset": "main",
+          "mapping": {
+            "x": { "field": "x" },
+            "y": { "field": "y" }
+          }
+        }
+      ]
+    }
+  ]
+}
+```
+
+### 2. Render from C++
+
+```cpp
+#define FLOW_PLOT_RENDERER
+#define FLOW_PLOT_IMPLEMENTATION
+#define FLOW_PLOT_DEFAULT_FONT_PATH "./FacultyGlyphic-Regular.ttf"
+#include "FlowPlot_Mega.hpp"
+
+#include <vector>
+
+int main()
+{
+    std::vector<int> x{1, 2, 3, 4, 5};
+    std::vector<int> y{3, 4, 1, 4, 6};
+
+    FlowPlot::plot("./ScatterTemplate.json")
+        .withData("main.x", x)
+        .withData("main.y", y)
+        .writePng("./out.png");
+}
+```
+
+### 3. Compile
+
+```bash
+g++ -std=c++20 -I. -IFlowPlot main.cpp -o plot
+```
+
+## Public API
+
+- `FlowPlot::plot(path)` loads template JSON (`.json` extension optional).
+- `PlotBuilder::set("path.to.prop", value)` mutates template JSON before compile.
+  - `value` supports: `int`, `float`, `double`, `bool`, `const char*`, `std::string`, `std::string_view`.
+- `PlotBuilder::setJsonRaw("path.to.prop", jsonText)` sets a property from raw JSON text (object/array/primitive).
+- `PlotBuilder::withData("dataset.field", std::span<const T>)`
+- `PlotBuilder::withData("dataset.field", const std::vector<T>&)`
+- `PlotBuilder::useTextEngine(engine)` injects a custom text engine.
+- `PlotBuilder::getCommands()` returns `RenderPlot` (resolved command stream).
+- `PlotBuilder::writePng(path)` (only when `FLOW_PLOT_RENDERER` is enabled).
+- `FlowPlot::registerFonts(textEngine, templateJsonText)` registers every root-level `fonts[]` entry with an `ITextEngine`.
+- `FlowPlot::getCompleteJson(templateJsonText, pretty = true)` (only when `FLOW_PLOT_COMPLETE_JSON` is enabled).
+
+## Defines
+
+### Required in specific modes
+
+- `FLOW_PLOT_RENDERER`
+  - Enables renderer integration (`CpuRenderer`, `StbTextEngine`, `PlotBuilder::writePng`).
+  - Define before including headers (or pass as compiler define).
+
+- `FLOW_PLOT_IMPLEMENTATION`
+  - Required in exactly one translation unit if you use built-in stb implementations.
+  - Without this (and without external stb implementation), renderer builds can compile but will fail to link when stb symbols are needed.
+
+### Optional
+
+- `FLOW_PLOT_DEFAULT_FONT_PATH`
+  - String literal path to a default TTF file auto-registered by `StbTextEngine`.
+  - `PlotBuilder::writePng` and renderer-enabled `PlotBuilder::getCommands` auto-create a fallback `StbTextEngine` if none is set; this default font path makes that work out of the box.
+
+- `FLOW_PLOT_COMPLETE_JSON`
+  - Enables full-template normalization helper: `getCompleteJson(templateJsonText, pretty)`.
+
+- `FLOW_PLOT_STB_EXTERNAL_IMPLEMENTATION`
+  - Use when you provide stb implementations externally.
+  - Disables FlowPlot’s internal stb implementation emission.
+
+### Internal (do not set manually)
+
+Examples: `FLOW_PLOT_HPP_INCLUDED`, `FLOW_PLOT_RENDERER_HPP_INCLUDED`, `FLOW_PLOT_DEFINED_STBTT_IMPLEMENTATION`, etc.
+
+## Template Schema (Overview)
+
+Root object:
+
+- `version` (`"1.0"`)
+- `fonts` optional array of font variants
+- `figure`
+- `datasets`
+- `layout`
+- `panels`
+
+### `fonts`
+
+Optional root-level font manifest. Each entry describes one concrete font face:
+
+```json
+{
+  "family": "Inter",
+  "weight": 400,
+  "style": "normal",
+  "path": "/absolute/path/to/Inter-Regular.ttf"
+}
+```
+
+- `family`: family name referenced by text specs.
+- `weight`: numeric font weight, usually `100..900`.
+- `style`: `normal`, `italic`, or `oblique`.
+- `path`: absolute path to a `.ttf`/`.ttc` font file.
+
+The built-in fallback `StbTextEngine` automatically registers these entries for `writePng()` and renderer-enabled `getCommands()`. Custom text engines can opt in by calling `FlowPlot::registerFonts(engine, templateJsonText)`.
+
+### `figure`
+
+Includes width/height/dpi/background/padding/title/legends.
+
+### `datasets`
+
+Each dataset has:
+
+- `name`
+- `schema` map where values are `number`, `string`, or `boolean`
+
+Runtime data binding uses:
+
+- `withData("datasetName.fieldName", data)`
+
+### `panels`
+
+Each panel has:
+
+- style/frame/title
+- axes: `xAxis`, `yAxis`, `xSecondary`, `ySecondary`
+- `layers`
+
+### `layers`
+
+Common layer fields:
+
+- `type`: `scatter` or `histogram`
+- `dataset`: dataset name
+- `axisData`: `{ "x": "primary|secondary|null", "y": "primary|secondary|null" }`
+- `mapping`, `style`, `stats`, `config`
+
+Scatter mapping (important fields):
+
+- `mapping.x.field` (required)
+- `mapping.y.field` (required)
+- optional: `mapping.color.field`, `mapping.size.field`, `mapping.label.field`
+
+Histogram mapping (important fields):
+
+- `mapping.data.field` (required)
+- `mapping.data.axis`: `"x"` or `"y"` (which axis receives input data)
+- optional color field/mapping
+
+Notes:
+
+- If no layer contributes data to an axis and no explicit `min/max` is provided, axis domain falls back to `0..1`.
+- You must define panels/layers/mappings if you want automatic domain inference from data.
+
+## Renderer Pipeline
+
+High-level flow:
+
+1. Template JSON -> compiled spec
+2. Spec + data views -> bound IR
+3. Bound IR + text metrics -> resolved IR
+4. Resolved IR -> `RenderPlot` command stream
+5. `CpuRenderer` rasterizes commands to RGBA8 image / PNG
+
+Command variants include:
+
+- `BoxCommand`
+- `PolylineCommand`
+- `TextCommand`
+- `MarkersCommand`
+- clip stack commands (`PushClipRectCommand`, `PopClipRectCommand`)
+
+## Text Engine Pluggability
+
+`ITextEngine` is pluggable for text metrics/layout:
+
+- `registerFont(...)`
+- `hasFont(...)`
+- `measureText(...)`
+- `layoutText(...)`
+
+Built-in `StbTextEngine` provides UTF-8 layout and glyph bitmap raster support used by the CPU renderer.
+
+Important current behavior:
+
+- `resolvePlotIR` needs a text engine for auto-sized text boxes.
+- `PlotBuilder::writePng` and renderer-enabled `PlotBuilder::getCommands` auto-fall back to `StbTextEngine` when no engine is explicitly set.
+- The fallback `StbTextEngine` automatically registers root `fonts[]` entries before resolving text.
+- If no default font is available, `writePng` throws with guidance (`useTextEngine(...)` or set `FLOW_PLOT_DEFAULT_FONT_PATH`).
+- Font lookup uses `family + weight + style`, with fallback to normal style/default weight/default family where possible.
+- Non-`StbTextEngine` custom engines can drive measurement/layout, but glyph rasterization in the built-in renderer is currently specialized for `StbTextEngine`.
+
+## Header Options
+
+You can use modular headers (`FlowPlot/FlowPlot.hpp`) or one of four generated amalgamated headers.
+
+Regenerate all amalgamated variants with:
+
+```bash
+python3 tools/generate_flowplot_mega.py
+```
+
+Generated outputs:
+
+- `FlowPlot_Mega_Core.hpp`
+  - Inlines FlowPlot headers only.
+  - Leaves RapidJSON and stb external (`-IFlowPlot` needed for bundled deps).
+- `FlowPlot_Mega_Stb.hpp`
+  - Inlines FlowPlot + stb headers.
+  - Leaves RapidJSON external (`-IFlowPlot` needed for bundled deps).
+- `FlowPlot_Mega_Json.hpp`
+  - Inlines FlowPlot + used RapidJSON subset.
+  - Leaves stb external (`-IFlowPlot` needed only if renderer/stb paths are used).
+- `FlowPlot_Mega.hpp`
+  - Inlines FlowPlot + used RapidJSON subset + stb.
+  - Fully self-contained single header (copy one file and include it).
+
+All variants support the same feature macros and runtime API.
+
+## JSON Backend
+
+FlowPlot uses RapidJSON. The JSON-inlined mega variants include only the RapidJSON subset reachable from FlowPlot's actual include usage.
+
+## Documentation Status
+
+This is a temporary README. FlowPlot will get full documentation and a pre-v1.0.0 release soon.

flowplotpy-0.9.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+flowplot/__init__.py,sha256=2DpS_1Y1jwgu5EXhA1xZ7fCnQAeyZRSxNtpoNcvEBb8,524
+flowplot/_flowplot.cp312-win32.pyd,sha256=eufKC-VtJ5zIYcQoNg1sReqsZj8fcvMdOajLJfAUTeg,580608
+flowplot/fonts/Inter.ttf,sha256=C-I5nqkl8fg_-XR2R2HamGDsUHQu0ppdTB_9DFx6w6g,874708
+flowplotpy-0.9.0.dist-info/METADATA,sha256=fDT9xJ7ycPj-BpaGOhkFoE7Puya09cQBkaBT3SxxklQ,10883
+flowplotpy-0.9.0.dist-info/WHEEL,sha256=7q7aL6J9-_ppcqL4lHNpGoblmIMqhpoisy0h6dXpSoE,102
+flowplotpy-0.9.0.dist-info/LICENSE,sha256=mpGwczbyUj695hGQNlPZcN9ZG0Sp3iLy7H9A5lamIo0,1086
+flowplotpy-0.9.0.dist-info/RECORD,,

flowplotpy-0.9.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: scikit-build-core 0.12.2
+Root-Is-Purelib: false
+Tag: cp312-cp312-win32
+