chromatic-python 0.3.4__tar.gz → 0.4.0__tar.gz

chromatic_python-0.4.0/.github/workflows/publish.yml

@@ -0,0 +1,22 @@
+on:
+  release:
+    types: [published]
+
+jobs:
+  build-and-publish:
+    if: ${{ !github.event.release.draft && !github.event.release.prerelease }}
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - run: python -m pip install --upgrade pip build
+      - run: python -m build
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          print-hash: true

chromatic_python-0.4.0/.github/workflows/tag-to-release.yml

@@ -0,0 +1,17 @@
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.ref_name }}
+          name: ${{ github.ref_name }}
+          generate_release_notes: true
+          prerelease: ${{ contains(github.ref_name, '-') }}

{chromatic_python-0.3.4 → chromatic_python-0.4.0}/.gitignore

@@ -1,11 +1,6 @@
 *.pyc
 *.pyo
 __pycache__/
-/.idea/
-/dist/
-/docs/
-/tests/_*
-/chromatic/data/userfont.json
 /chromatic/_version.py
-/*.egg-info/
-/build/
+/chromatic/data/userfont.json
+/tests/_*

{chromatic_python-0.3.4/chromatic_python.egg-info → chromatic_python-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: chromatic-python
-Version: 0.3.4
+Version: 0.4.0
 Summary: ANSI art image processing and colored terminal text
 Author: crypt0lith
 Project-URL: Homepage, https://github.com/crypt0lith/chromatic
@@ -23,7 +23,7 @@ Requires-Dist: fonttools
 Requires-Dist: lazy_loader
 Dynamic: license-file
 
-![image](/logo/logo.PNG)
+![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)
@@ -35,89 +35,108 @@ Chromatic is a library for processing and transforming ANSI escape sequences (co
 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 which enables precise low-level control over ANSI-escaped strings through a convenient interface.
+- A `ColorStr` type for low-level control over ANSI SGR strings.
 - [colorama](https://github.com/tartley/colorama/)-style wrappers (`Fore`, `Back`, `Style`).
-- Parametrization of ANSI color bit formats, allowing arbitrary conversion between 16-color, 256-color, and true-color (RGB) colorspace on any object implementing a `colorbytes` buffer.
+- Conversion between 16-color, 256-color, and true-color (RGB) ANSI colorspace via the `colorbytes` type.
 - Et Cetera 😲
 
 ### Usage
+#### Image-to-ANSI conversion
+
+Convert an image into a 2d ANSI string array, and render the ANSI array as image:
+```python
+from chromatic.color import ansicolor4Bit
+from chromatic.image import ansi2img, img2ansi
+from chromatic.data import userfont, butterfly
+
+input_img = butterfly()
+font = userfont['vga437']
+
+# `char_set` is used to translate luminance to characters 
+#            | <- index 0 is the 'darkest'
+char_set = r"'·,•-_→+<>ⁿ*%⌂7√Iï∞πbz£9yîU{}1αHSw♥æ?GX╕╒éà⌡MF╝╩ΘûǃQ½☻Ŷ┤▄╪║▒█"
+#                                           index -1 is the 'brightest' -> |
+
+# returns list[list[ColorStr]]
+ansi_array = img2ansi(
+	input_img,
+	font,
+	sort_glyphs=False,	# map `char_set` as-is
+	char_set=char_set,
+	ansi_type=ansicolor4Bit,
+	factor=200,
+)
+
+# print your image to stdout
+print(*map(''.join, ansi_array), sep="\x1b[0m\n")
+
+# returns a PIL.Image.Image object
+ansi_img = ansi2img(ansi_array, font, font_size=16)
+ansi_img.show()
+```
+
 #### ColorStr
 ```python
 from chromatic import ColorStr
 
 base_str = 'hello world'
 
-red_fg = ColorStr(base_str, 0xFF0000)
+red_fg = ColorStr(base_str, 0xFF0000, ansi_type='8b')
 
 assert red_fg.base_str == base_str
 assert red_fg.rgb_dict == {'fg': (0xFF, 0, 0)}
 assert red_fg.ansi == b'\x1b[38;5;196m'
 ```
 
-`ColorStr` can handle different signatures for `color_spec`:
+`ColorStr` will parse raw SGR sequences, and accepts different types for `fg` and `bg`:
 ```python
 from chromatic import ColorStr
 
-assert all(
-	ColorStr('*', cs) == ColorStr('*', 0xFF0000)
-    for cs in [b'\x1b[38;5;196m', b'\xff\x00\x00', (0xFF, 0, 0), {'fg': 0xFF0000}]
-)
+red_fg = ColorStr('[*]', 0xFF0000, ansi_type='8b')
+
+assert red_fg == ColorStr(b"\x1b[38;5;196m[*]")
+assert red_fg == ColorStr('[*]', fg=(0xFF, 0, 0), ansi_type='8b')
 ```
 
-The ANSI color format can be given as an argument, or returned by `ColorStr.as_ansi_type()` as a new instance.
+ANSI color format can be specified with `ColorStr(ansi_type=...)`, or as a new object via `ColorStr.as_ansi_type()`:
 ```python
-from chromatic import ColorStr, ansicolor24Bit, ansicolor4Bit
+from chromatic import ColorStr, ansicolor4Bit, ansicolor24Bit, ansicolor8Bit
+
+# each colorbytes type has an alias that you can use 
+assert all(
+	ansi_type.alias == alias
+	for ansi_type, alias in [
+        (ansicolor4Bit, '4b'),
+		(ansicolor8Bit, '8b'),
+		(ansicolor24Bit, '24b'),
+	]
+)
 
 truecolor = ColorStr('*', 0xFF0000, ansi_type=ansicolor24Bit)
 a_16color = truecolor.as_ansi_type(ansicolor4Bit)
 
-# each ansi color format has an alias that can be used in place of the type object
 assert a_16color == truecolor.as_ansi_type('4b')
-
 assert truecolor.ansi_format is ansicolor24Bit and truecolor.ansi == b'\x1b[38;2;255;0;0m'
 assert a_16color.ansi_format is ansicolor4Bit and a_16color.ansi == b'\x1b[31m'
 ```
 
-Adding and removing specific ANSI codes from the escape sequence:
+Adding and removing SGR parameters from a `ColorStr`:
 ```python
 import chromatic as cm
 
-boring_str = cm.ColorStr('hello world')
+regular_str = cm.ColorStr('hello world')
 
-assert boring_str.ansi == b''
+assert regular_str.ansi == b''
+
+bold_str = regular_str.bold()
 
-bold_str = boring_str + cm.SgrParameter.BOLD
 assert bold_str.ansi == b'\x1b[1m'
 
 # use ColorStr.update_sgr() to remove and add SGR values
 unbold_str = bold_str.update_sgr(cm.SgrParameter.BOLD)
-assert unbold_str == boring_str
-assert bold_str == unbold_str.update_sgr(cm.SgrParameter.BOLD)
-```
-
-#### Image-to-ANSI conversion
-
-Converting an image into an array of ANSI-escaped characters, then rendering the ANSI array as another image:
-```python
-from chromatic.color import ansicolor4Bit
-from chromatic.ascii import ansi2img, img2ansi
-from chromatic.data import UserFont, butterfly
 
-input_img = butterfly()
-
-font = UserFont.IBM_VGA_437_8X16
-
-# by default, `char_set` would be sorted based on the relative weight of glyphs in the font
-# but because `sort_glyphs` is set to False, `char_set` will be directly mapped to the image brightness
-#            | <- index 0 is the 'darkest'
-char_set = r"'·,•-_→+<>ⁿ*%⌂7√Iï∞πbz£9yîU{}1αHSw♥æ?GX╕╒éà⌡MF╝╩ΘûǃQ½☻Ŷ┤▄╪║▒█"
-#                                            index -1 is the 'brightest' -> |
-
-ansi_array = img2ansi(input_img, font, sort_glyphs=False, char_set=char_set, ansi_type=ansicolor4Bit, factor=200)
-
-# ansi2img() returns a PIL.Image.Image object
-ansi_img = ansi2img(ansi_array, font, font_size=16)
-ansi_img.show()
+assert unbold_str == regular_str
+assert bold_str == unbold_str + cm.SgrParameter.BOLD	# __add__ can also be used
 ```
 
 ### Installation
@@ -125,3 +144,6 @@ Install the package using `pip`:
 ```bash
 pip install chromatic-python
 ```
+
+### Credits
+Banner artwork: [main rules by Crasher (2002)](https://16colo.rs/pack/galza-14/CRS-MAIN.ANS)

chromatic_python-0.4.0/README.md

@@ -0,0 +1,124 @@
+![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/)
+
+Chromatic is a library for processing and transforming ANSI escape sequences (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
+#### Image-to-ANSI conversion
+
+Convert an image into a 2d ANSI string array, and render the ANSI array as image:
+```python
+from chromatic.color import ansicolor4Bit
+from chromatic.image import ansi2img, img2ansi
+from chromatic.data import userfont, butterfly
+
+input_img = butterfly()
+font = userfont['vga437']
+
+# `char_set` is used to translate luminance to characters 
+#            | <- index 0 is the 'darkest'
+char_set = r"'·,•-_→+<>ⁿ*%⌂7√Iï∞πbz£9yîU{}1αHSw♥æ?GX╕╒éà⌡MF╝╩ΘûǃQ½☻Ŷ┤▄╪║▒█"
+#                                           index -1 is the 'brightest' -> |
+
+# returns list[list[ColorStr]]
+ansi_array = img2ansi(
+	input_img,
+	font,
+	sort_glyphs=False,	# map `char_set` as-is
+	char_set=char_set,
+	ansi_type=ansicolor4Bit,
+	factor=200,
+)
+
+# print your image to stdout
+print(*map(''.join, ansi_array), sep="\x1b[0m\n")
+
+# returns a PIL.Image.Image object
+ansi_img = ansi2img(ansi_array, font, font_size=16)
+ansi_img.show()
+```
+
+#### ColorStr
+```python
+from chromatic import ColorStr
+
+base_str = 'hello world'
+
+red_fg = ColorStr(base_str, 0xFF0000, ansi_type='8b')
+
+assert red_fg.base_str == base_str
+assert red_fg.rgb_dict == {'fg': (0xFF, 0, 0)}
+assert red_fg.ansi == b'\x1b[38;5;196m'
+```
+
+`ColorStr` will parse raw SGR sequences, and accepts different types for `fg` and `bg`:
+```python
+from chromatic import ColorStr
+
+red_fg = ColorStr('[*]', 0xFF0000, ansi_type='8b')
+
+assert red_fg == ColorStr(b"\x1b[38;5;196m[*]")
+assert red_fg == ColorStr('[*]', fg=(0xFF, 0, 0), ansi_type='8b')
+```
+
+ANSI color format can be specified with `ColorStr(ansi_type=...)`, or as a new object via `ColorStr.as_ansi_type()`:
+```python
+from chromatic import ColorStr, ansicolor4Bit, ansicolor24Bit, ansicolor8Bit
+
+# each colorbytes type has an alias that you can use 
+assert all(
+	ansi_type.alias == alias
+	for ansi_type, alias in [
+        (ansicolor4Bit, '4b'),
+		(ansicolor8Bit, '8b'),
+		(ansicolor24Bit, '24b'),
+	]
+)
+
+truecolor = ColorStr('*', 0xFF0000, ansi_type=ansicolor24Bit)
+a_16color = truecolor.as_ansi_type(ansicolor4Bit)
+
+assert a_16color == truecolor.as_ansi_type('4b')
+assert truecolor.ansi_format is ansicolor24Bit and truecolor.ansi == b'\x1b[38;2;255;0;0m'
+assert a_16color.ansi_format is ansicolor4Bit and a_16color.ansi == b'\x1b[31m'
+```
+
+Adding and removing SGR parameters from a `ColorStr`:
+```python
+import chromatic as cm
+
+regular_str = cm.ColorStr('hello world')
+
+assert regular_str.ansi == b''
+
+bold_str = regular_str.bold()
+
+assert bold_str.ansi == b'\x1b[1m'
+
+# use ColorStr.update_sgr() to remove and add SGR values
+unbold_str = bold_str.update_sgr(cm.SgrParameter.BOLD)
+
+assert unbold_str == regular_str
+assert bold_str == unbold_str + cm.SgrParameter.BOLD	# __add__ can also be used
+```
+
+### Installation
+Install the package using `pip`:
+```bash
+pip install chromatic-python
+```
+
+### Credits
+Banner artwork: [main rules by Crasher (2002)](https://16colo.rs/pack/galza-14/CRS-MAIN.ANS)

{chromatic_python-0.3.4 → chromatic_python-0.4.0}/chromatic/__init__.pyi

@@ -87,4 +87,4 @@ from .image import (
     reshape_ansi,
     to_sgr_array,
 )
-from .image._glyph_proc import get_glyph_masks, sort_glyphs, ttf_extract_codepoints
+from .image._glyph import get_glyph_masks, sort_glyphs, ttf_extract_codepoints

{chromatic_python-0.3.4 → chromatic_python-0.4.0}/chromatic/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.3.4'
-__version_tuple__ = version_tuple = (0, 3, 4)
+__version__ = version = '0.4.0'
+__version_tuple__ = version_tuple = (0, 4, 0)
 
-__commit_id__ = commit_id = 'gb93479602'
+__commit_id__ = commit_id = 'g2288358be'

{chromatic_python-0.3.4 → chromatic_python-0.4.0}/chromatic/color/colorconv.py

@@ -59,7 +59,7 @@ def is_u24(value, *, strict: bool = False):
     ValueError
         Raised when `strict=True` and value is not u24
     """
-    if _supports_int(type(value)):
+    if _supports_int(value.__class__):
         if 0 <= int(value) <= 0xFFFFFF:
             return True
         elif not strict:
@@ -92,7 +92,9 @@ def int2rgb(__x: int) -> Int3Tuple:
     try:
         return getattr(__x, 'rgb')
     except AttributeError:
-        return (__x >> 16) & 0xFF, (__x >> 8) & 0xFF, __x & 0xFF
+        pass
+    x = int(__x) & 0xFFFFFF
+    return (x >> 16) & 0xFF, (x >> 8) & 0xFF, x & 0xFF
 
 
 def xyz2lab(xyz: FloatSequence) -> Float3Tuple: