sixelmath 0.1__tar.gz

sixelmath-0.1/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2026 Collin J. Delker
+
+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.

sixelmath-0.1/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: sixelmath
+Version: 0.1
+Summary: Render LaTeX math and Sympy expressions to Sixel Terminal Graphics. Suuports any Math-enabled font, no LaTeX installation required.
+Home-page: https://github.com/cdelker/sixelmath
+Author: Collin J. Delker
+Author-email: code@collindelker.com
+License: MIT
+Project-URL: Documentation, https://github.com/cdelker/sixelmath
+Project-URL: Source Code, https://github.com/cdelker/sixelmath
+Keywords: LaTeX,math,sympy,sixel,terminal
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+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: Programming Language :: Python :: 3.14
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: ziamath>=0.13
+Requires-Dist: latex2mathml
+Requires-Dist: timg
+Requires-Dist: cairosvg
+Requires-Dist: Pillow
+Dynamic: license-file
+
+# sixelmath
+
+Render LaTeX Math expressions or Sympy objects in the terminal using sixel graphics.
+Math rendering is done using [ziamath](https://ziamath.readthedocs.io), a pure-Python LaTeX math renderer that does not require a Latex installation.
+Any math-enabled truetype/opentype font may be used; STIXTwoMath-Regular is included and used by default.
+Also uses [cairosvg](https://pypi.org/project/CairoSVG/), [timg](https://pypi.org/project/timg/), and [Pillow](https://pypi.org/project/pillow/).
+
+See list of sixel-supported terminal emulators [here](https://www.arewesixelyet.com).
+
+
+## Usage
+
+### Command Line
+
+Render a LaTeX expression:
+
+    sixelmath "\frac{1}{1+x}"
+
+Options include:
+
+* '-s': Font size in points
+* '-f': Path to font file (must include MATH table)
+* '-c': Color as a supported named color, or hex value such as `#FFFFFF`
+* '-b': Background color as a supported named color, or hex value such as `#FFFFFF`
+* '-m': Margin width in pixels
+
+In POSIX environments, the font and background color are detected automatically if not manually specified.
+
+
+### Python
+
+To render LaTeX from Python code:
+
+    from sixelmath import sixelmath
+    sixelmath(r'\frac{1}{1+x}')
+    
+Keyword arguments may be passed to `sixelmath` to change options:
+
+* `color`: Font color. A named terminal color like 'white', or RGB hex color such as `#FFFFFF`
+* `bgcolor`: Background color.
+* `font`: Path to a TTF or OTF font file. Must contain a MATH table. STIXTwoMath-Regular is used by default.
+* `fontsize`: Font size in pixels
+* `margin`: Pixel margin around the euqation
+
+
+### Sympy
+
+Import the `sixelmath.sympysixel` module to install a Sympy Printer that automatically displays Sympy expressions as sixel graphics.
+
+    import sympy
+    from sixelmath import sympysixel
+    sympy.sympify('A * exp(-x^2)')
+
+
+To change display format, use `sixelmath.sixel_defaults`, with the same keyword arguments listed above for `sixelmath`.
+The sixel printer may be turned off using `sympysixel.disable()` and turned on with `sympysixel.enable()`.

sixelmath-0.1/README.md

@@ -0,0 +1,56 @@
+# sixelmath
+
+Render LaTeX Math expressions or Sympy objects in the terminal using sixel graphics.
+Math rendering is done using [ziamath](https://ziamath.readthedocs.io), a pure-Python LaTeX math renderer that does not require a Latex installation.
+Any math-enabled truetype/opentype font may be used; STIXTwoMath-Regular is included and used by default.
+Also uses [cairosvg](https://pypi.org/project/CairoSVG/), [timg](https://pypi.org/project/timg/), and [Pillow](https://pypi.org/project/pillow/).
+
+See list of sixel-supported terminal emulators [here](https://www.arewesixelyet.com).
+
+
+## Usage
+
+### Command Line
+
+Render a LaTeX expression:
+
+    sixelmath "\frac{1}{1+x}"
+
+Options include:
+
+* '-s': Font size in points
+* '-f': Path to font file (must include MATH table)
+* '-c': Color as a supported named color, or hex value such as `#FFFFFF`
+* '-b': Background color as a supported named color, or hex value such as `#FFFFFF`
+* '-m': Margin width in pixels
+
+In POSIX environments, the font and background color are detected automatically if not manually specified.
+
+
+### Python
+
+To render LaTeX from Python code:
+
+    from sixelmath import sixelmath
+    sixelmath(r'\frac{1}{1+x}')
+    
+Keyword arguments may be passed to `sixelmath` to change options:
+
+* `color`: Font color. A named terminal color like 'white', or RGB hex color such as `#FFFFFF`
+* `bgcolor`: Background color.
+* `font`: Path to a TTF or OTF font file. Must contain a MATH table. STIXTwoMath-Regular is used by default.
+* `fontsize`: Font size in pixels
+* `margin`: Pixel margin around the euqation
+
+
+### Sympy
+
+Import the `sixelmath.sympysixel` module to install a Sympy Printer that automatically displays Sympy expressions as sixel graphics.
+
+    import sympy
+    from sixelmath import sympysixel
+    sympy.sympify('A * exp(-x^2)')
+
+
+To change display format, use `sixelmath.sixel_defaults`, with the same keyword arguments listed above for `sixelmath`.
+The sixel printer may be turned off using `sympysixel.disable()` and turned on with `sympysixel.enable()`.

sixelmath-0.1/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"

sixelmath-0.1/setup.cfg

@@ -0,0 +1,51 @@
+[metadata]
+name = sixelmath
+version = attr: sixelmath.__version__
+author = Collin J. Delker
+author_email = code@collindelker.com
+url = https://github.com/cdelker/sixelmath
+description = Render LaTeX math and Sympy expressions to Sixel Terminal Graphics. Suuports any Math-enabled font, no LaTeX installation required.
+long_description = file: README.md
+long_description_content_type = text/markdown
+keywords = LaTeX, math, sympy, sixel, terminal
+license = MIT
+project_urls = 
+	Documentation = https://github.com/cdelker/sixelmath
+	Source Code = https://github.com/cdelker/sixelmath
+classifiers = 
+	Development Status :: 4 - Beta
+	Programming Language :: Python :: 3
+	Programming Language :: Python :: 3.9
+	Programming Language :: Python :: 3.10
+	Programming Language :: Python :: 3.11
+	Programming Language :: Python :: 3.12
+	Programming Language :: Python :: 3.13
+	Programming Language :: Python :: 3.14
+	License :: OSI Approved :: MIT License
+	Operating System :: OS Independent
+	Intended Audience :: Education
+	Intended Audience :: Science/Research
+	Intended Audience :: End Users/Desktop
+	Intended Audience :: Developers
+	Topic :: Scientific/Engineering :: Mathematics
+
+[options]
+packages = find:
+zip_safe = False
+python_requires = >= 3.9
+include_package_data = True
+install_requires = 
+	ziamath>=0.13
+	latex2mathml
+	timg
+	cairosvg
+	Pillow
+
+[options.entry_points]
+console_scripts = 
+	sixelmath = sixelmath.__main__:main
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

sixelmath-0.1/sixelmath/__init__.py

@@ -0,0 +1,4 @@
+from .latex import sixelmath, sixel_defaults
+
+__version__ = 0.1
+

sixelmath-0.1/sixelmath/__main__.py

@@ -0,0 +1,37 @@
+''' Command-line program to print tex to sixel '''
+import argparse
+import pathlib
+
+from sixelmath import sixelmath, sixel_defaults
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description='Render LaTeX math in terminal using sixel graphics')
+    parser.add_argument(
+        'tex', type=str, default='',
+        help='LaTeX math expression')
+    parser.add_argument(
+        '-s', '--size', type=float, default=24,
+        help='Font size')
+    parser.add_argument(
+        '-f', '--font', type=pathlib.Path, default=None,
+        help='Path to TTF or OTF font with MATH tables')
+    parser.add_argument(
+        '-c', '--color', type=str, default=None,
+        help='Font color as named color or hex #RRGGBB')
+    parser.add_argument(
+        '-b', '--bgcolor', type=str, default=None,
+        help='Background color')
+    parser.add_argument(
+        '-m', '--margin', type=int, default=4,
+        help='Pixel margin surrounding equation')
+
+    args = parser.parse_args()
+    sixel_defaults(
+        font=args.font,
+        fontsize=args.size,
+        color=args.color,
+        bgcolor=args.bgcolor,
+        margin=args.margin)
+    sixelmath(args.tex)

sixelmath-0.1/sixelmath/latex.py

@@ -0,0 +1,87 @@
+''' Render LaTeX math expressions as sixel graphics '''
+import io
+import os
+from functools import partial
+
+import cairosvg
+import timg
+import ziamath as zm
+
+
+def _sixelmath(
+    tex,
+    fontsize,
+    font,
+    color,
+    bgcolor,
+    margin
+):
+    ''' Print LaTeX math expression to sixel
+
+        Args:
+            tex: LaTeX expression to render
+            fontsize: Font size in points
+            font: Path to font file with MATH table.
+                STIXTwoMath-Regular used by default.
+            color: Font color as named color or hex #RRGGBB
+            bgcolor: Background color
+            margin: Pixel margin around equation
+    '''
+    svg = zm.Latex(
+        tex,
+        font=font,
+        size=fontsize,
+        color=color,
+        margin=margin
+    ).svg()
+    png = cairosvg.svg2png(svg, background_color=bgcolor)
+    renderer = timg.Renderer()
+    renderer.load_image_from_file(io.BytesIO(png))
+    renderer.render(timg.SixelMethod)
+
+
+sixelmath = partial(
+    _sixelmath, fontsize=24, font=None,
+    color='#fcfcfc', bgcolor='#232627',
+    margin=4)
+sixelmath.__doc__ = _sixelmath.__doc__
+
+
+def sixel_defaults(
+    fontsize=None,
+    font=None,
+    color=None,
+    bgcolor=None,
+    margin=None
+):
+    ''' Set default parameters. Use None to leave unchanged.
+
+        Args:
+            fontsize: Font size in points
+            font: Path to font file with MATH table
+            color: Font color as named color or hex #RRGGBB
+            bgcolor: Background color
+            margin: Pixel margin around equation
+    '''
+    if fontsize:
+        sixelmath.keywords['fontsize'] = fontsize
+    if font:
+        sixelmath.keywords['font'] = font
+    if color:
+        sixelmath.keywords['color'] = color
+    if bgcolor:
+        sixelmath.keywords['bgcolor'] = bgcolor
+    if margin is not None:
+        sixelmath.keywords['margin'] = margin
+
+
+if os.name == 'posix':
+    # Detect terminal foreground/background colors.
+    # Only works on POSIX, and may not supoprt all terminals.
+    from . import querycolor
+    fg = querycolor.get_default_fg()
+    bg = querycolor.get_default_bg()
+    if fg is not None:
+        sixel_defaults(color=fg)
+    if bg is not None:
+        sixel_defaults(bgcolor=bg)

sixelmath-0.1/sixelmath/querycolor.py

@@ -0,0 +1,100 @@
+''' Determine terminal foreground and background colors
+
+    Source: https://jwodder.github.io/kbits/posts/term-fgbg/
+    John T. Wodder II, CC-BY-4.0
+'''
+from __future__ import annotations
+from collections.abc import Iterator
+from contextlib import contextmanager
+from copy import deepcopy
+import re
+import sys
+import termios
+
+
+def parse_color(color):
+    if color.startswith('rgb:'):
+        rgb = f'#{color[4:6]}{color[9:11]}{color[14:16]}'
+    else:
+        rgb = None
+    return rgb
+
+
+def get_default_fg() -> str:
+    """
+    Query the attached terminal for the default foreground color and return the
+    color string from the response
+
+    :raises IOError: if stdin or stdout is not a terminal
+    :raises ValueError: if the reply from the terminal is malformed
+    """
+    try:
+        color = osc_query(10)
+    except (ValueError, IOError):
+        return None
+    else:
+        return parse_color(color)
+
+
+def get_default_bg() -> str:
+    """
+    Query the attached terminal for the default background color and return the
+    color string from the response
+
+    :raises IOError: if stdin or stdout is not a terminal
+    :raises ValueError: if the reply from the terminal is malformed
+    """
+    try:
+        color = osc_query(11)
+    except (ValueError, IOError):
+        return None
+    else:
+        return parse_color(color)
+
+
+def osc_query(ps: int) -> str:
+    if sys.stdin.isatty() and sys.stdout.isatty():
+        with cbreak_noecho():
+            print(f"\x1b]{ps};?\x1b\\", end="", flush=True)
+            resp = b""
+            while not resp.endswith((b"\x1b\\", b"\x07")):
+                resp += sys.stdin.buffer.read(1)
+        s = resp.decode("utf-8", "surrogateescape")
+        if m := re.fullmatch(rf"\x1B\]{ps};(.+)(?:\x1B\\|\x07)", s):
+            return m[1]
+        else:
+            raise ValueError(s)
+    else:
+        raise IOError("not connected to a terminal")
+
+
+# File descriptor for standard input:
+STDIN = 0
+
+# Indices into the tuple returned by `tcgetattr()`:
+LFLAG = 3
+CC = 6
+
+
+@contextmanager
+def cbreak_noecho() -> Iterator[None]:
+    """
+    A context manager that configures the terminal on standard input to use
+    cbreak mode and to disable input echoing.  The original terminal
+    configuration is restored on exit.
+    """
+    orig = termios.tcgetattr(STDIN)
+    term = deepcopy(orig)
+    term[LFLAG] &= ~(termios.ICANON | termios.ECHO)
+    term[CC][termios.VMIN] = 1
+    term[CC][termios.VTIME] = 0
+    termios.tcsetattr(STDIN, termios.TCSANOW, term)
+    try:
+        yield
+    finally:
+        termios.tcsetattr(STDIN, termios.TCSANOW, orig)
+
+
+if __name__ == "__main__":
+    print("Foreground color:", get_default_fg())
+    print("Background color:", get_default_bg())

sixelmath-0.1/sixelmath/sympysixel.py

@@ -0,0 +1,28 @@
+''' Import this module to install a sympy __repr__ using sixel graphics '''
+import sympy
+from sympy.printing.defaults import Printable
+
+from .latex import sixelmath
+
+
+def sympysixel(sym):
+    ''' Print Sympy expression to sixel '''
+    tex = sympy.latex(sym)
+    sixelmath(tex)
+    return ''
+
+
+_default_repr = Printable.__repr__
+
+
+def disable():
+    ''' Disable sympy sixel printer '''
+    Printable.__repr__ = _default_repr
+
+
+def enable():
+    ''' Enable sympy sixel printer '''
+    Printable.__repr__ = sympysixel
+
+
+enable()

sixelmath-0.1/sixelmath.egg-info/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: sixelmath
+Version: 0.1
+Summary: Render LaTeX math and Sympy expressions to Sixel Terminal Graphics. Suuports any Math-enabled font, no LaTeX installation required.
+Home-page: https://github.com/cdelker/sixelmath
+Author: Collin J. Delker
+Author-email: code@collindelker.com
+License: MIT
+Project-URL: Documentation, https://github.com/cdelker/sixelmath
+Project-URL: Source Code, https://github.com/cdelker/sixelmath
+Keywords: LaTeX,math,sympy,sixel,terminal
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+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: Programming Language :: Python :: 3.14
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: ziamath>=0.13
+Requires-Dist: latex2mathml
+Requires-Dist: timg
+Requires-Dist: cairosvg
+Requires-Dist: Pillow
+Dynamic: license-file
+
+# sixelmath
+
+Render LaTeX Math expressions or Sympy objects in the terminal using sixel graphics.
+Math rendering is done using [ziamath](https://ziamath.readthedocs.io), a pure-Python LaTeX math renderer that does not require a Latex installation.
+Any math-enabled truetype/opentype font may be used; STIXTwoMath-Regular is included and used by default.
+Also uses [cairosvg](https://pypi.org/project/CairoSVG/), [timg](https://pypi.org/project/timg/), and [Pillow](https://pypi.org/project/pillow/).
+
+See list of sixel-supported terminal emulators [here](https://www.arewesixelyet.com).
+
+
+## Usage
+
+### Command Line
+
+Render a LaTeX expression:
+
+    sixelmath "\frac{1}{1+x}"
+
+Options include:
+
+* '-s': Font size in points
+* '-f': Path to font file (must include MATH table)
+* '-c': Color as a supported named color, or hex value such as `#FFFFFF`
+* '-b': Background color as a supported named color, or hex value such as `#FFFFFF`
+* '-m': Margin width in pixels
+
+In POSIX environments, the font and background color are detected automatically if not manually specified.
+
+
+### Python
+
+To render LaTeX from Python code:
+
+    from sixelmath import sixelmath
+    sixelmath(r'\frac{1}{1+x}')
+    
+Keyword arguments may be passed to `sixelmath` to change options:
+
+* `color`: Font color. A named terminal color like 'white', or RGB hex color such as `#FFFFFF`
+* `bgcolor`: Background color.
+* `font`: Path to a TTF or OTF font file. Must contain a MATH table. STIXTwoMath-Regular is used by default.
+* `fontsize`: Font size in pixels
+* `margin`: Pixel margin around the euqation
+
+
+### Sympy
+
+Import the `sixelmath.sympysixel` module to install a Sympy Printer that automatically displays Sympy expressions as sixel graphics.
+
+    import sympy
+    from sixelmath import sympysixel
+    sympy.sympify('A * exp(-x^2)')
+
+
+To change display format, use `sixelmath.sixel_defaults`, with the same keyword arguments listed above for `sixelmath`.
+The sixel printer may be turned off using `sympysixel.disable()` and turned on with `sympysixel.enable()`.

sixelmath-0.1/sixelmath.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+LICENSE.txt
+README.md
+pyproject.toml
+setup.cfg
+sixelmath/__init__.py
+sixelmath/__main__.py
+sixelmath/latex.py
+sixelmath/querycolor.py
+sixelmath/sympysixel.py
+sixelmath.egg-info/PKG-INFO
+sixelmath.egg-info/SOURCES.txt
+sixelmath.egg-info/dependency_links.txt
+sixelmath.egg-info/entry_points.txt
+sixelmath.egg-info/not-zip-safe
+sixelmath.egg-info/requires.txt
+sixelmath.egg-info/top_level.txt

sixelmath-0.1/sixelmath.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

sixelmath-0.1/sixelmath.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+sixelmath = sixelmath.__main__:main

sixelmath-0.1/sixelmath.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

sixelmath-0.1/sixelmath.egg-info/requires.txt

@@ -0,0 +1,5 @@
+ziamath>=0.13
+latex2mathml
+timg
+cairosvg
+Pillow

sixelmath-0.1/sixelmath.egg-info/top_level.txt

@@ -0,0 +1 @@
+sixelmath