pyansistring 0.0.2__tar.gz

pyansistring-0.0.2/.gitignore

@@ -0,0 +1,165 @@
+# Local tests
+tests/untracked
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

pyansistring-0.0.2/LICENSE

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

pyansistring-0.0.2/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.3
+Name: pyansistring
+Version: 0.0.2
+Summary: A small library for fast color styling of the string using ANSI escape sequences.
+Project-URL: Repository, https://github.com/l1asis/pyansistring.git
+Project-URL: Issues, https://github.com/l1asis/pyansistring/issues
+Author: Volodymyr Horshenin
+License: MIT License
+        
+        Copyright (c) 2024 Volodymyr Horshenin
+        
+        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.
+License-File: LICENSE
+Keywords: ANSI escape sequences,colored string,colored text,colors,terminal
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Other Audience
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Terminals
+Classifier: Topic :: Text Processing
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# pyansistring
+
+![pyansistring Banner](./images/banner.png)
+
+[***`pyansistring`***](https://github.com/l1asis/pyansistring) is a small library for fast **color styling** of the string using **ANSI escape sequences**. The base class inherits from Python's `str`. You can split, join, slice the string while preserving the styling. 
+
+Inspired by [***`rich`***](https://github.com/Textualize/rich) Python library.
+
+## **Features**
+- Preservation of the `str` methods.
+- RGB foreground and background coloring.
+- Per-word coloring.
+- Align left, right and center without the problems caused by the length of the string.
+
+#### For a more comprehensive list of what's been done so far, see the [***TODO***](./TODO.md) section.
+
+## **Install**
+Since the library is published on [PyPI](https://pypi.org/), it can be installed using pip:
+```
+pip install pyansistring
+```
+Or locally, by cloning the project:
+```
+git clone https://github.com/l1asis/pyansistring
+cd ./pyansistring/
+pip install .
+```
+
+## **Contributing**
+Any ideas (vectors) for improvements, actual help with implementations, bug fixes 
+and anything else is highly appreciated. You can also contribute by adding your 
+own art to the `arts.py` file in the `.\src\pyansistring` directory if you like.
+
+## **Usage**
+```python
+from pyansistring import ANSIString
+from pyansistring.constants import SGR, Foreground, Background
+
+# Does what it should: prints all text in bold, with magenta foreground and white background.
+print(ANSIString("Hello, World!").fg_4b(Foreground.MAGENTA).bg_4b(Background.WHITE).fm(SGR.BOLD))
+
+# But you can do the same on a specific slice:
+print(ANSIString("Hello, World!").fg_4b(Foreground.MAGENTA, (0, 4)).bg_4b(Background.WHITE, (2, 4)).fm(SGR.BOLD, (4, 6)))
+
+# Or if you want to apply styles to a specific word
+print(ANSIString("Hello, World!").fg_4b_w(Foreground.MAGENTA, "Hello", "World").bg_4b_w(Background.WHITE, "World").fm_w(SGR.BOLD, ","))
+
+# You may find predefined colors boring, let's do it with RGB:
+print(ANSIString("Hello, World!").fg_24b(255, 0, 255).bg_24b(255, 255, 255))
+
+# And of course you can do the same tricks with words:
+print(ANSIString("Hello, World!").fg_24b_w(255, 0, 255, "Hello").bg_24b_w(255, 255, 255, "World"))
+
+# By the way...
+print(len(ANSIString("Hello, World!").fg_4b(Foreground.MAGENTA)) == len("Hello, World!"))
+# -> True
+
+# Why? Because I wanted it to behave this way. But at the same time:
+print(len(ANSIString("Hello, World!").fg_4b(Foreground.MAGENTA).styled) == len("Hello, World!"))
+# -> False
+print(ANSIString("Hello, World!").fg_4b(Foreground.MAGENTA).actual_length == len("Hello, World!"))
+# -> False
+
+# If you need the original string:
+print(ANSIString("Hello, World!").fg_4b(Foreground.MAGENTA).plain)
+```

pyansistring-0.0.2/README.md

@@ -0,0 +1,66 @@
+# pyansistring
+
+![pyansistring Banner](./images/banner.png)
+
+[***`pyansistring`***](https://github.com/l1asis/pyansistring) is a small library for fast **color styling** of the string using **ANSI escape sequences**. The base class inherits from Python's `str`. You can split, join, slice the string while preserving the styling. 
+
+Inspired by [***`rich`***](https://github.com/Textualize/rich) Python library.
+
+## **Features**
+- Preservation of the `str` methods.
+- RGB foreground and background coloring.
+- Per-word coloring.
+- Align left, right and center without the problems caused by the length of the string.
+
+#### For a more comprehensive list of what's been done so far, see the [***TODO***](./TODO.md) section.
+
+## **Install**
+Since the library is published on [PyPI](https://pypi.org/), it can be installed using pip:
+```
+pip install pyansistring
+```
+Or locally, by cloning the project:
+```
+git clone https://github.com/l1asis/pyansistring
+cd ./pyansistring/
+pip install .
+```
+
+## **Contributing**
+Any ideas (vectors) for improvements, actual help with implementations, bug fixes 
+and anything else is highly appreciated. You can also contribute by adding your 
+own art to the `arts.py` file in the `.\src\pyansistring` directory if you like.
+
+## **Usage**
+```python
+from pyansistring import ANSIString
+from pyansistring.constants import SGR, Foreground, Background
+
+# Does what it should: prints all text in bold, with magenta foreground and white background.
+print(ANSIString("Hello, World!").fg_4b(Foreground.MAGENTA).bg_4b(Background.WHITE).fm(SGR.BOLD))
+
+# But you can do the same on a specific slice:
+print(ANSIString("Hello, World!").fg_4b(Foreground.MAGENTA, (0, 4)).bg_4b(Background.WHITE, (2, 4)).fm(SGR.BOLD, (4, 6)))
+
+# Or if you want to apply styles to a specific word
+print(ANSIString("Hello, World!").fg_4b_w(Foreground.MAGENTA, "Hello", "World").bg_4b_w(Background.WHITE, "World").fm_w(SGR.BOLD, ","))
+
+# You may find predefined colors boring, let's do it with RGB:
+print(ANSIString("Hello, World!").fg_24b(255, 0, 255).bg_24b(255, 255, 255))
+
+# And of course you can do the same tricks with words:
+print(ANSIString("Hello, World!").fg_24b_w(255, 0, 255, "Hello").bg_24b_w(255, 255, 255, "World"))
+
+# By the way...
+print(len(ANSIString("Hello, World!").fg_4b(Foreground.MAGENTA)) == len("Hello, World!"))
+# -> True
+
+# Why? Because I wanted it to behave this way. But at the same time:
+print(len(ANSIString("Hello, World!").fg_4b(Foreground.MAGENTA).styled) == len("Hello, World!"))
+# -> False
+print(ANSIString("Hello, World!").fg_4b(Foreground.MAGENTA).actual_length == len("Hello, World!"))
+# -> False
+
+# If you need the original string:
+print(ANSIString("Hello, World!").fg_4b(Foreground.MAGENTA).plain)
+```

pyansistring-0.0.2/TODO.md

@@ -0,0 +1,137 @@
+### `str` magic or dunder methods
+- [X] `__add__`
+- [ ] `__class__`
+- [ ] `__contains__`
+- [ ] `__delattr__`
+- [X] `__dir__`
+- [X] `__doc__`
+- [X] `__eq__`
+- [ ] `__format__`
+- [ ] `__ge__`
+- [ ] `__getattribute__`
+- [X] `__getitem__`
+- [ ] `__getnewargs__`
+- [ ] `__getstate__`
+- [ ] `__gt__`
+- [ ] `__hash__`
+- [X] `__init__`
+- [ ] `__init_subclass__`
+- [ ] `__iter__`
+- [ ] `__le__`
+- [X] `__len__`
+- [ ] `__lt__`
+- [ ] `__mod__`
+- [ ] `__mul__`
+- [X] `__ne__`
+- [ ] `__new__`
+- [ ] `__reduce__`
+- [ ] `__reduce_ex__`
+- [X] `__repr__`
+- [ ] `__rmod__`
+- [ ] `__rmul__`
+- [ ] `__setattr__`
+- [ ] `__sizeof__`
+- [X] `__str__`
+- [ ] `__subclasshook__`
+
+### `str` public methods
+- [X] `capitalize`
+- [ ] `casefold`
+- [X] `center`
+- [X] `count`
+- [ ] `encode`
+- [X] `endswith`
+- [ ] `expandtabs`
+- [X] `find`
+- [ ] `format`
+- [ ] `format_map`
+- [X] `index`
+- [X] `isalnum`
+- [X] `isalpha`
+- [X] `isascii`
+- [X] `isdecimal`
+- [X] `isdigit`
+- [X] `isidentifier`
+- [X] `islower`
+- [X] `isnumeric`
+- [X] `isprintable`
+- [X] `isspace`
+- [X] `istitle`
+- [X] `isupper`
+- [X] `join`
+- [X] `ljust`
+- [X] `lower`
+- [ ] `lstrip`
+- [ ] `maketrans`
+- [ ] `partition`
+- [ ] `removeprefix`
+- [ ] `removesuffix`
+- [ ] `replace`
+- [X] `rfind`
+- [X] `rindex`
+- [X] `rjust`
+- [ ] `rpartition`
+- [X] `rsplit`
+  - [X] whitespace
+  - [X] one char
+  - [X] two or more chars
+- [ ] `rstrip`
+- [X] `split`
+  - [X] whitespace
+  - [X] one char
+  - [X] two or more chars
+- [X] `splitlines`
+- [X] `startswith`
+- [ ] `strip`
+- [X] `swapcase`
+- [X] `title`
+- [ ] `translate`
+- [X] `upper`
+- [ ] `zfill`
+
+### `ANSIString` featured methods (magic, private and public)
+- [X] `__radd__`
+- [ ] `__copy__`
+- [ ] `__deepcopy__`
+
+- [X] `_render` (apply current styles to the plain string)
+- [X] `_get_indices` (...)
+- [X] `_search_spans` (...)
+
+- [X] `fm` (set SGR styling parameters)
+- [X] `fm_w` (`fm` per word)
+- [X] `unfm` (remove styles from the string)
+- [X] `unfm_w` (`unfm` per word)
+
+- [ ] ~~`fg` (shortcut to `fg_24b`)~~
+- [ ] ~~`fg_w` (shortcut to `fg_24b_w`)~~
+
+- [X] `fg_4b` (set foreground color using 4-bit color code)
+- [X] `fg_4b_w` (`fg_4b` per word)
+- [X] `fg_8b` (set foreground color using a pre-defined set of 256 colors)
+- [X] `fg_8b_w` (`fg_8b` per word)
+- [X] `fg_24b` (set foreground color using RGB color model, a.k.a. true color)
+- [X] `fg_24b_w` (`fg_24b` per word)
+
+- [ ] ~~`bg` (shortcut to `bg_24b`)~~
+- [ ] ~~`bg_w` (shortcut to `bg_24b_w`)~~
+
+- [X] `bg_4b` (set background color using 4-bit color code)
+- [X] `bg_4b_w` (`bg_4b` per word)
+- [X] `bg_8b` (set background color using a pre-defined set of 256 colors)
+- [X] `bg_8b_w` (`bg_8b` per word)
+- [X] `bg_24b` (set background color using RGB color model, a.k.a. true color)
+- [X] `bg_24b_w` (`bg_24b` per word)
+
+- [ ] `ul_8b` (set underline color using a pre-defined set of 256 colors)
+- [ ] `ul_8b_w` (`ul_8b` per word)
+- [ ] `ul_24b` (set underline color using RGB color model, a.k.a. true color)
+- [ ] `ul_24b_w` (`ul_24b` per word)
+
+
+- [X] `multicolor` (apply a specific custom coloring using the provided coloring system)
+- [X] `multicolor_c` (`multicolor` using coordinates, it's useful for multiline strings)
+- [ ] `colormap` (apply a specific predefined coloring)
+- [X] `rainbow` (apply rainbow coloring (using a separate algorithm))
+- [ ] `random_art` (return random color art)
+- [X] `from_ansi` (create `ANSIString` from plain `str` with ANSI escape sequences)

pyansistring-0.0.2/pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pyansistring"
+version = "0.0.2"
+requires-python = ">=3.10"
+authors = [
+  {name="Volodymyr Horshenin"},
+]
+description = "A small library for fast color styling of the string using ANSI escape sequences."
+readme = "README.md"
+license = {file = "LICENSE"}
+keywords = ["colored string", "colored text", "colors", "ANSI escape sequences", "terminal"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Other Audience",
+  "Topic :: Terminals",
+  "Topic :: Text Processing",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Operating System :: OS Independent",
+]
+
+[project.urls]
+Repository = "https://github.com/l1asis/pyansistring.git"
+Issues = "https://github.com/l1asis/pyansistring/issues"

pyansistring-0.0.2/src/pyansistring/__init__.py

@@ -0,0 +1,16 @@
+"""
+pyansistring
+"""
+
+__all__ = [
+    "pyansistring",
+    "constants",
+    "helpers",
+    "arts",
+    "ANSIString",
+    "StyleDict",
+]
+__title__ = "pyansistring"
+__license__ = "MIT"
+
+from pyansistring.pyansistring import *