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

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

@@ -0,0 +1,29 @@
+on:
+  push:
+    tags:
+      - "v*.*.*"
+permissions:
+  contents: write
+  id-token: write
+jobs:
+  build-publish-release:
+    runs-on: ubuntu-latest
+    environment: pypi
+    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
+      - 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, '-') }}
+          files: |
+            dist/*

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

@@ -1,6 +1,6 @@
-*.pyc
-*.pyo
-__pycache__/
-/chromatic/_version.py
-/chromatic/data/userfont.json
-/tests/_*
+*.pyc
+*.pyo
+__pycache__/
+/chromatic/_version.py
+/chromatic/data/userfont.json
+/tests/_*

{chromatic_python-0.4.0 → chromatic_python-0.4.1}/LICENSE

@@ -1,21 +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
+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.4.0 → chromatic_python-0.4.1}/PKG-INFO

@@ -1,149 +1,149 @@
-Metadata-Version: 2.4
-Name: chromatic-python
-Version: 0.4.0
-Summary: ANSI art image processing and colored terminal text
-Author: crypt0lith
-Project-URL: Homepage, https://github.com/crypt0lith/chromatic
-Keywords: ansi,ascii,art,font,image,terminal,parser
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Operating System :: OS Independent
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Typing :: Typed
-Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: numpy<2.6,>=1.25.2
-Requires-Dist: pillow!=11.2.*,<12.0,>=10.1
-Requires-Dist: networkx<4.0,>=3.0
-Requires-Dist: scipy<2.0,>=1.11.4
-Requires-Dist: opencv-python
-Requires-Dist: scikit-image
-Requires-Dist: scikit-learn
-Requires-Dist: fonttools
-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/)
-
-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)
+Metadata-Version: 2.4
+Name: chromatic-python
+Version: 0.4.1
+Summary: ANSI art image processing and colored terminal text
+Author: crypt0lith
+Project-URL: Homepage, https://github.com/crypt0lith/chromatic
+Keywords: ansi,ascii,art,font,image,terminal,parser
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy<2.6,>=1.25.2
+Requires-Dist: pillow!=11.2.*,<12.0,>=10.1
+Requires-Dist: networkx<4.0,>=3.0
+Requires-Dist: scipy<2.0,>=1.11.4
+Requires-Dist: opencv-python
+Requires-Dist: scikit-image
+Requires-Dist: scikit-learn
+Requires-Dist: fonttools
+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/)
+
+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.4.0 → chromatic_python-0.4.1}/README.md

@@ -1,124 +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)
+![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.4.0 → chromatic_python-0.4.1}/chromatic/__init__.py

@@ -1,8 +1,8 @@
-try:
-    from ._version import version as __version__
-except ImportError:
-    __version__ = "0.0.0"
-
-import lazy_loader as _lazy
-
-__getattr__, __dir__, __all__ = _lazy.attach_stub(__name__, __file__)
+try:
+    from ._version import version as __version__
+except ImportError:
+    __version__ = "0.0.0"
+
+import lazy_loader as _lazy
+
+__getattr__, __dir__, __all__ = _lazy.attach_stub(__name__, __file__)