gum-jsx 0.4__tar.gz

gum_jsx-0.4/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.4
+Name: gum-jsx
+Version: 0.4
+Summary: Python wrapper for gum.jsx, a language for creating vector graphics
+Author: Douglas Hanley
+License: MIT
+Project-URL: Homepage, https://github.com/CompendiumLabs/gum.py
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+<div align="center">
+<img src="image/logo.svg" alt="gum.py" width="500" />
+<br/>
+</div>
+
+<div align="center">
+<img src="image/nexus.svg" alt="nexus" width="250" />
+<br/><br/>
+</div>
+
+A Python wrapper for [gum.js](https://github.com/CompendiumLabs/gum.js), a language for creating visualizations using a React-like JSX dialect that evaluates to SVG. Designed for general graphics, plots, graphs, and network diagrams.
+
+Head to **[compendiumlabs.ai/gum](https://compendiumlabs.ai/gum)** for a live demo and documentation on the underlying gum.js library. Or see the [gum.js](https://github.com/CompendiumLabs/gum.js) repository.
+
+# Installation
+
+```bash
+pip install gum-py
+```
+
+Requires Node.js to be installed for the gum.js backend.
+
+# Usage
+
+Create visualizations using Python syntax that generates JSX:
+
+```python
+import gum
+from gum import C
+from gum.gen import Plot, SymLine
+
+# create a simple sine wave plot
+plot = Plot(
+    SymLine(fy=C.sin, stroke=C.blue, stroke_width=2),
+    xlim=(0, 2*C.pi), ylim=(-1, 1), grid=True, margin=0.2, aspect=2,
+)
+
+# display in terminal (requires chafa)
+gum.display(plot) # or just `plot` if you're in IPython or Jupyter
+
+# or get the SVG string
+svg = gum.evaluate(plot)
+
+# or get the JSX code
+jsx = str(plot)
+```
+
+If you're in IPython or Jupyter, you don't even need to call `display`. Just type `plot` and it will automatically display the visualization inline.
+
+## Pandas Integration
+
+Plot DataFrames directly with high-level functions:
+
+```python
+import pandas as pd
+import numpy as np
+from gum import lines, points, bars
+
+# line plot from DataFrame
+th = np.linspace(0, 2*np.pi, 100)
+df = pd.DataFrame({ 'sin': np.sin(th), 'cos': np.cos(th) })
+lines(df, margin=0.15)
+
+# bar chart from Series
+bars(pd.Series({'A': 3, 'B': 8, 'C': 5}))
+```
+
+## Symbolic Expressions
+
+Use `C` for constants and `V` for variables:
+
+```python
+from gum import C, V
+from gum.gen import Plot, SymLine, SymPoints
+
+# C references gum.js constants and functions
+C.sin, C.cos, C.pi, C.blue, C.red
+
+# build symbolic expressions
+decay = lambda x: C.exp(-x/2) * C.sin(3*x)
+
+# V creates named variables bound to data
+theta = V.theta(np.linspace(0, 2*np.pi, 100))
+```
+
+# CLI
+
+Display gum visualizations directly in the terminal using `chafa`. Requires a terminal with image support, such as `ghostty`.
+
+```bash
+# run a built-in demo
+python -m gum -d plot -s 50
+
+# pipe JSX code
+cat input.jsx | python -m gum
+```
+
+CLI options:
+
+| Option | Description | Default |
+|--------|-------------|---------|
+| `-d, --demo <name>` | Run a named demo | - |
+| `-s, --size <size>` | Terminal display size | 50 |
+| `-t, --theme <theme>` | Theme: `light` or `dark` | dark |
+
+Available demos: `plot`, `barplot`, `network`, `symline`, `grid`, `stack`, `text`, and more (see `gum/dem.py`).
+
+# Jupyter Support
+
+`gum.py` automatically renders SVG in IPython console and Jupyter notebooks:
+
+```python
+from gum import Plot, SymLine, C
+
+# this will display inline in Jupyter
+Plot(
+    SymLine(fy=C.sin),
+    xlim=(0, 2*C.pi), ylim=(-1, 1), grid=True,
+)
+```
+
+# Components
+
+gum.py wraps all gum.js components. Key ones include:
+
+**Layout**: `Box`, `Frame`, `Stack`, `HStack`, `VStack`, `Grid`, `Points`
+
+**Shapes**: `Rect`, `Ellipse`, `Circle`, `Line`, `Shape`, `Spline`
+
+**Text**: `Text`, `TextFrame`, `Latex`, `Equation`
+
+**Plotting**: `Plot`, `Graph`, `Axis`, `HAxis`, `VAxis`, `BarPlot`
+
+**Symbolic**: `SymLine`, `SymPoints`, `SymShape`, `SymSpline`, `SymFill`, `SymField`
+
+**Network**: `Node`, `Edge`, `Network`, `Arrow`
+
+See the [gum.js documentation](https://compendiumlabs.ai/gum/docs) for detailed component reference.

gum_jsx-0.4/README.md

@@ -0,0 +1,138 @@
+<div align="center">
+<img src="image/logo.svg" alt="gum.py" width="500" />
+<br/>
+</div>
+
+<div align="center">
+<img src="image/nexus.svg" alt="nexus" width="250" />
+<br/><br/>
+</div>
+
+A Python wrapper for [gum.js](https://github.com/CompendiumLabs/gum.js), a language for creating visualizations using a React-like JSX dialect that evaluates to SVG. Designed for general graphics, plots, graphs, and network diagrams.
+
+Head to **[compendiumlabs.ai/gum](https://compendiumlabs.ai/gum)** for a live demo and documentation on the underlying gum.js library. Or see the [gum.js](https://github.com/CompendiumLabs/gum.js) repository.
+
+# Installation
+
+```bash
+pip install gum-py
+```
+
+Requires Node.js to be installed for the gum.js backend.
+
+# Usage
+
+Create visualizations using Python syntax that generates JSX:
+
+```python
+import gum
+from gum import C
+from gum.gen import Plot, SymLine
+
+# create a simple sine wave plot
+plot = Plot(
+    SymLine(fy=C.sin, stroke=C.blue, stroke_width=2),
+    xlim=(0, 2*C.pi), ylim=(-1, 1), grid=True, margin=0.2, aspect=2,
+)
+
+# display in terminal (requires chafa)
+gum.display(plot) # or just `plot` if you're in IPython or Jupyter
+
+# or get the SVG string
+svg = gum.evaluate(plot)
+
+# or get the JSX code
+jsx = str(plot)
+```
+
+If you're in IPython or Jupyter, you don't even need to call `display`. Just type `plot` and it will automatically display the visualization inline.
+
+## Pandas Integration
+
+Plot DataFrames directly with high-level functions:
+
+```python
+import pandas as pd
+import numpy as np
+from gum import lines, points, bars
+
+# line plot from DataFrame
+th = np.linspace(0, 2*np.pi, 100)
+df = pd.DataFrame({ 'sin': np.sin(th), 'cos': np.cos(th) })
+lines(df, margin=0.15)
+
+# bar chart from Series
+bars(pd.Series({'A': 3, 'B': 8, 'C': 5}))
+```
+
+## Symbolic Expressions
+
+Use `C` for constants and `V` for variables:
+
+```python
+from gum import C, V
+from gum.gen import Plot, SymLine, SymPoints
+
+# C references gum.js constants and functions
+C.sin, C.cos, C.pi, C.blue, C.red
+
+# build symbolic expressions
+decay = lambda x: C.exp(-x/2) * C.sin(3*x)
+
+# V creates named variables bound to data
+theta = V.theta(np.linspace(0, 2*np.pi, 100))
+```
+
+# CLI
+
+Display gum visualizations directly in the terminal using `chafa`. Requires a terminal with image support, such as `ghostty`.
+
+```bash
+# run a built-in demo
+python -m gum -d plot -s 50
+
+# pipe JSX code
+cat input.jsx | python -m gum
+```
+
+CLI options:
+
+| Option | Description | Default |
+|--------|-------------|---------|
+| `-d, --demo <name>` | Run a named demo | - |
+| `-s, --size <size>` | Terminal display size | 50 |
+| `-t, --theme <theme>` | Theme: `light` or `dark` | dark |
+
+Available demos: `plot`, `barplot`, `network`, `symline`, `grid`, `stack`, `text`, and more (see `gum/dem.py`).
+
+# Jupyter Support
+
+`gum.py` automatically renders SVG in IPython console and Jupyter notebooks:
+
+```python
+from gum import Plot, SymLine, C
+
+# this will display inline in Jupyter
+Plot(
+    SymLine(fy=C.sin),
+    xlim=(0, 2*C.pi), ylim=(-1, 1), grid=True,
+)
+```
+
+# Components
+
+gum.py wraps all gum.js components. Key ones include:
+
+**Layout**: `Box`, `Frame`, `Stack`, `HStack`, `VStack`, `Grid`, `Points`
+
+**Shapes**: `Rect`, `Ellipse`, `Circle`, `Line`, `Shape`, `Spline`
+
+**Text**: `Text`, `TextFrame`, `Latex`, `Equation`
+
+**Plotting**: `Plot`, `Graph`, `Axis`, `HAxis`, `VAxis`, `BarPlot`
+
+**Symbolic**: `SymLine`, `SymPoints`, `SymShape`, `SymSpline`, `SymFill`, `SymField`
+
+**Network**: `Node`, `Edge`, `Network`, `Arrow`
+
+See the [gum.js documentation](https://compendiumlabs.ai/gum/docs) for detailed component reference.

gum_jsx-0.4/gum/__init__.py

@@ -0,0 +1,6 @@
+from .gum import chafa, evaluate, display, display_file, restart, display as D, GumError, GumErrorType
+from .utl import Var, Con, Element, DisplayMixin, DataGroup, Group, stringify
+from .gen import V, C, GumData
+from .viz import lines, points, bars, test_data
+from .dem import demo
+from . import gen as G

gum_jsx-0.4/gum/__main__.py

@@ -0,0 +1,18 @@
+# main entry point
+
+import sys
+import argparse
+from .dem import demo
+from .gum import display
+
+if __name__ == '__main__':
+    # parse command line arguments
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-d', '--demo', type=str, help='the demo to run', default=None)
+    parser.add_argument('-s', '--size', type=int, help='the size of the display', default=50)
+    parser.add_argument('-t', '--theme', type=str, help='the theme to use', default='dark')
+    args = parser.parse_args()
+
+    # dispatch commands
+    elem = demo(args.demo) if args.demo is not None else sys.stdin.read()
+    display(elem, size=args.size, theme=args.theme)