chromatic-python 0.8.1__tar.gz → 0.9.1__tar.gz

chromatic_python-0.9.1/.github/workflows/build.yml

@@ -0,0 +1,33 @@
+name: build
+
+on: [workflow_dispatch, push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.12', '3.13', '3.14']
+    steps:
+      - uses: actions/checkout@v7
+      - uses: astral-sh/setup-uv@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install OpenCV runtime libraries
+        run: sudo apt-get update && sudo apt-get install -y libgl1
+      - run: uv run --group tests pytest
+
+  bench:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/checkout@v7
+      - uses: astral-sh/setup-uv@v7
+      - name: Install OpenCV runtime libraries
+        run: sudo apt-get update && sudo apt-get install -y libgl1
+      - uses: CodSpeedHQ/action@v5
+        with:
+          mode: simulation
+          run: uv run --group tests pytest --codspeed

chromatic_python-0.9.1/LICENSE

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

chromatic_python-0.9.1/PKG-INFO

@@ -0,0 +1,180 @@
+Metadata-Version: 2.4
+Name: chromatic-python
+Version: 0.9.1
+Summary: ANSI art image processing and colored terminal text
+Author: crypt0lith
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/crypt0lith/chromatic
+Project-URL: Documentation, https://crypt0lith.github.io/chromatic
+Keywords: ansi,ascii,art,font,image,terminal,parser
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: <4.0,>=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy<2.8,>=2.1
+Requires-Dist: pillow>=12.2.0
+Requires-Dist: scipy>=1.11.4
+Requires-Dist: opencv-python
+Requires-Dist: fonttools>=4.60.2
+Requires-Dist: lazy_loader
+Dynamic: license-file
+
+![image](https://raw.githubusercontent.com/crypt0lith/chromatic/master/banner.png)
+
+[![image](https://img.shields.io/pypi/v/chromatic-python)](https://pypi.org/project/chromatic-python/)
+![image](https://img.shields.io/pypi/pyversions/chromatic-python)
+[![image](https://static.pepy.tech/badge/chromatic-python)](https://pepy.tech/projects/chromatic-python)
+[![image](https://mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
+[![CodSpeed](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://app.codspeed.io/crypt0lith/chromatic?utm_source=badge)
+
+Chromatic is a library for ANSI art image processing and colored terminal text.
+
+It offers a collection of algorithms and types for a variety of use cases:
+
+- Image-to-ASCII / Image-to-ANSI conversions.
+- ANSI art rendering, with support for user-defined fonts.
+- A `ColorStr` type for low-level control over ANSI SGR strings.
+- [colorama](https://github.com/tartley/colorama/)-style wrappers (`Fore`, `Back`, `Style`).
+- Conversion between 16-color, 256-color, and true-color (RGB) ANSI colorspace via the `colorbytes` type.
+- Et Cetera 😲
+
+### Usage
+
+#### `ColorStr`
+
+```python
+from chromatic import ColorStr
+
+cs = ColorStr("hello world", fg=0xFF0000, ansi_type="8b")
+
+assert cs.base_str == "hello world"
+assert len(cs) == len("hello world")
+
+head, tail = cs.split()
+
+assert head.fg == tail.fg == cs.fg
+assert all(c.fg == cs.fg for c in cs)
+```
+
+`ColorStr` is a `str` subclass that carries SGR state as metadata.
+Its `str` methods delegate to the base string and return `ColorStr` instances that retain the SGR state.
+
+```python
+assert str(cs) == "\x1b[38;5;196mhello world\x1b[0m"
+assert cs.ansi == b"\x1b[38;5;196m"
+```
+
+The SGR sequence materializes when the `ColorStr` is converted back to a Python `str`.
+
+#### `color_chain`
+
+```python
+from chromatic import color_chain
+
+cc = color_chain(
+    [ColorStr("hello", fg=0xFF0000), ColorStr(" world", fg=0x00FF00)], ansi_type="8b"
+)
+
+sgr, s = cc[0]
+
+assert sgr.fg == (0xFF, 0, 0)
+assert s == "hello"
+```
+
+A `color_chain` is a sequence of colored-text fragments that round-trips with a structured NumPy array.
+Each fragment is an `(sgr, text)` pair of the SGR state and the run of text it applies to.
+
+```python
+cc2 = color_chain("\x1b[38;5;196mhello\x1b[38;5;46m world")
+
+assert cc == cc2
+```
+
+The constructor also parses a raw SGR string.
+It infers the color depth from the sequence, so `cc2` needs no `ansi_type`.
+
+```python
+arr = cc.term_array()
+
+assert arr.dtype == [("char", "<U1"), ("sgr", "<u8"), ("rgb", "u1", (2, 4))]
+assert str(color_chain.fromarray(arr)) == str(cc)
+```
+
+`term_array` exposes the structured `ndarray` behind the chain, and `fromarray` reverses it.
+`fromarray` accepts any `ndarray` of that dtype, so an array built by other means converts to a printable `color_chain`.
+
+#### `img2ansi`
+
+```python
+from chromatic import img2ansi
+
+cc = img2ansi("input.png")
+```
+
+`img2ansi` reads an image and returns a `color_chain`.
+
+```python
+arr = img2ansi("input.png", outarray=True)
+
+assert color_chain.fromarray(arr) == cc
+```
+
+`outarray=True` returns the underlying `ndarray` instead.
+
+#### `ansi2img`
+
+```python
+from chromatic import ansi2img
+
+img = ansi2img(cc)
+img.show()
+```
+
+`ansi2img` renders a `color_chain` back to an image.
+It also accepts a dtype-matching array.
+
+#### `ansify`
+
+```python
+from chromatic import ansify
+
+img = ansify("input.png")
+arr = img.info["ansi_array"]
+```
+
+`ansify` runs both directions in one call, returning the rendered image with the array it rendered from on `Image.info`.
+
+#### Animated images
+
+```python
+frames = img2ansi("input.gif")
+
+assert isinstance(frames, list)
+assert all(isinstance(f, color_chain) for f in frames)
+```
+
+An animated image renders to a `list[color_chain]`, one per frame.
+
+```shell
+chromatic image ansify input.gif --stdout
+```
+
+The [CLI](https://crypt0lith.github.io/chromatic/cli/image/#chromatic-image-ansify) renders and plays one straight to the terminal.
+
+### Installation
+
+Install the package using `pip`:
+
+```shell
+pip install chromatic-python
+```
+
+### Credits
+
+Banner artwork: [main rules by Crasher (2002)](https://16colo.rs/pack/galza-14/CRS-MAIN.ANS)

chromatic_python-0.9.1/README.md

@@ -0,0 +1,153 @@
+![image](https://raw.githubusercontent.com/crypt0lith/chromatic/master/banner.png)
+
+[![image](https://img.shields.io/pypi/v/chromatic-python)](https://pypi.org/project/chromatic-python/)
+![image](https://img.shields.io/pypi/pyversions/chromatic-python)
+[![image](https://static.pepy.tech/badge/chromatic-python)](https://pepy.tech/projects/chromatic-python)
+[![image](https://mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
+[![CodSpeed](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://app.codspeed.io/crypt0lith/chromatic?utm_source=badge)
+
+Chromatic is a library for ANSI art image processing and colored terminal text.
+
+It offers a collection of algorithms and types for a variety of use cases:
+
+- Image-to-ASCII / Image-to-ANSI conversions.
+- ANSI art rendering, with support for user-defined fonts.
+- A `ColorStr` type for low-level control over ANSI SGR strings.
+- [colorama](https://github.com/tartley/colorama/)-style wrappers (`Fore`, `Back`, `Style`).
+- Conversion between 16-color, 256-color, and true-color (RGB) ANSI colorspace via the `colorbytes` type.
+- Et Cetera 😲
+
+### Usage
+
+#### `ColorStr`
+
+```python
+from chromatic import ColorStr
+
+cs = ColorStr("hello world", fg=0xFF0000, ansi_type="8b")
+
+assert cs.base_str == "hello world"
+assert len(cs) == len("hello world")
+
+head, tail = cs.split()
+
+assert head.fg == tail.fg == cs.fg
+assert all(c.fg == cs.fg for c in cs)
+```
+
+`ColorStr` is a `str` subclass that carries SGR state as metadata.
+Its `str` methods delegate to the base string and return `ColorStr` instances that retain the SGR state.
+
+```python
+assert str(cs) == "\x1b[38;5;196mhello world\x1b[0m"
+assert cs.ansi == b"\x1b[38;5;196m"
+```
+
+The SGR sequence materializes when the `ColorStr` is converted back to a Python `str`.
+
+#### `color_chain`
+
+```python
+from chromatic import color_chain
+
+cc = color_chain(
+    [ColorStr("hello", fg=0xFF0000), ColorStr(" world", fg=0x00FF00)], ansi_type="8b"
+)
+
+sgr, s = cc[0]
+
+assert sgr.fg == (0xFF, 0, 0)
+assert s == "hello"
+```
+
+A `color_chain` is a sequence of colored-text fragments that round-trips with a structured NumPy array.
+Each fragment is an `(sgr, text)` pair of the SGR state and the run of text it applies to.
+
+```python
+cc2 = color_chain("\x1b[38;5;196mhello\x1b[38;5;46m world")
+
+assert cc == cc2
+```
+
+The constructor also parses a raw SGR string.
+It infers the color depth from the sequence, so `cc2` needs no `ansi_type`.
+
+```python
+arr = cc.term_array()
+
+assert arr.dtype == [("char", "<U1"), ("sgr", "<u8"), ("rgb", "u1", (2, 4))]
+assert str(color_chain.fromarray(arr)) == str(cc)
+```
+
+`term_array` exposes the structured `ndarray` behind the chain, and `fromarray` reverses it.
+`fromarray` accepts any `ndarray` of that dtype, so an array built by other means converts to a printable `color_chain`.
+
+#### `img2ansi`
+
+```python
+from chromatic import img2ansi
+
+cc = img2ansi("input.png")
+```
+
+`img2ansi` reads an image and returns a `color_chain`.
+
+```python
+arr = img2ansi("input.png", outarray=True)
+
+assert color_chain.fromarray(arr) == cc
+```
+
+`outarray=True` returns the underlying `ndarray` instead.
+
+#### `ansi2img`
+
+```python
+from chromatic import ansi2img
+
+img = ansi2img(cc)
+img.show()
+```
+
+`ansi2img` renders a `color_chain` back to an image.
+It also accepts a dtype-matching array.
+
+#### `ansify`
+
+```python
+from chromatic import ansify
+
+img = ansify("input.png")
+arr = img.info["ansi_array"]
+```
+
+`ansify` runs both directions in one call, returning the rendered image with the array it rendered from on `Image.info`.
+
+#### Animated images
+
+```python
+frames = img2ansi("input.gif")
+
+assert isinstance(frames, list)
+assert all(isinstance(f, color_chain) for f in frames)
+```
+
+An animated image renders to a `list[color_chain]`, one per frame.
+
+```shell
+chromatic image ansify input.gif --stdout
+```
+
+The [CLI](https://crypt0lith.github.io/chromatic/cli/image/#chromatic-image-ansify) renders and plays one straight to the terminal.
+
+### Installation
+
+Install the package using `pip`:
+
+```shell
+pip install chromatic-python
+```
+
+### Credits
+
+Banner artwork: [main rules by Crasher (2002)](https://16colo.rs/pack/galza-14/CRS-MAIN.ANS)

{chromatic_python-0.8.1 → chromatic_python-0.9.1}/chromatic/__init__.pyi

@@ -3,6 +3,7 @@ __all__ = [
     "Color",
     "ColorNamespace",
     "ColorStr",
+    "DEFAULT_FONT",
     "Fore",
     "SgrFlag",
     "SgrParameter",
@@ -38,10 +39,10 @@ __all__ = [
     "reshape_ansi",
     "rgb2hexstr",
     "rgb2int",
+    "set_default_ansi",
     "sort_glyphs",
     "ttf_extract_codepoints",
     "userfonts",
-    "set_default_ansi",
 ]
 from . import color, data, image
 from ._version import version as __version__
@@ -66,7 +67,7 @@ from .color import (
     rgb2int,
     set_default_ansi,
 )
-from .data import UserFont, register_userfont, userfonts
+from .data import DEFAULT_FONT, UserFont, register_userfont, userfonts
 from .image import (
     ansi2img,
     ansi_quantize,