Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jshwi/object-colors

Object-oriented library for stylizing terminal output
https://github.com/jshwi/object-colors

ansi color oop terminal tty

Last synced: 28 days ago
JSON representation

Object-oriented library for stylizing terminal output

Host: GitHub
URL: https://github.com/jshwi/object-colors
Owner: jshwi
License: mit
Created: 2019-09-19T12:58:07.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-04-12T11:59:16.000Z (10 months ago)
Last Synced: 2024-04-12T18:41:59.284Z (10 months ago)
Topics: ansi, color, oop, terminal, tty
Language: Python
Homepage: https://object-colors.readthedocs.io
Size: 1.07 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        Status: Archived

==================

This repository has been archived and is no longer maintained

object-colors

=============

|Inactive| |License| |PyPI| |CI| |CodeQL| |pre-commit.ci status| |codecov.io| |readthedocs.org| |python3.8| |Black| |isort| |docformatter| |pylint| |Security Status| |Known Vulnerabilities| |borgini|

.. |Inactive| image:: https://img.shields.io/badge/status-inactive-red.svg

    :target: https://img.shields.io/badge/status-inactive-red.svg

    :alt: Status Inactive

.. |License| image:: https://img.shields.io/badge/License-MIT-yellow.svg

    :target: https://opensource.org/licenses/MIT

    :alt: License

.. |PyPI| image:: https://img.shields.io/pypi/v/object-colors

    :target: https://pypi.org/project/object-colors/

    :alt: PyPI

.. |CI| image:: https://github.com/jshwi/object-colors/actions/workflows/build.yaml/badge.svg

    :target: https://github.com/jshwi/object-colors/actions/workflows/build.yaml

    :alt: CI

.. |CodeQL| image:: https://github.com/jshwi/object-colors/actions/workflows/codeql-analysis.yml/badge.svg

    :target: https://github.com/jshwi/object-colors/actions/workflows/codeql-analysis.yml

    :alt: CodeQL

.. |pre-commit.ci status| image:: https://results.pre-commit.ci/badge/github/jshwi/object-colors/master.svg

    :target: https://results.pre-commit.ci/latest/github/jshwi/object-colors/master

    :alt: pre-commit.ci status

.. |codecov.io| image:: https://codecov.io/gh/jshwi/object-colors/branch/master/graph/badge.svg

    :target: https://codecov.io/gh/jshwi/object-colors

    :alt: codecov.io

.. |readthedocs.org| image:: https://readthedocs.org/projects/object-colors/badge/?version=latest

    :target: https://object-colors.readthedocs.io/en/latest/?badge=latest

    :alt: readthedocs.org

.. |python3.8| image:: https://img.shields.io/badge/python-3.8-blue.svg

    :target: https://www.python.org/downloads/release/python-380

    :alt: python3.8

.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :target: https://github.com/psf/black

    :alt: Black

.. |isort| image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336

    :target: https://pycqa.github.io/isort/

    :alt: isort

.. |docformatter| image:: https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg

    :target: https://github.com/PyCQA/docformatter

    :alt: docformatter

.. |pylint| image:: https://img.shields.io/badge/linting-pylint-yellowgreen

    :target: https://github.com/PyCQA/pylint

    :alt: pylint

.. |Security Status| image:: https://img.shields.io/badge/security-bandit-yellow.svg

    :target: https://github.com/PyCQA/bandit

    :alt: Security Status

.. |Known Vulnerabilities| image:: https://snyk.io/test/github/jshwi/object-colors/badge.svg

    :target: https://snyk.io/test/github/jshwi/object-colors/badge.svg

    :alt: Known Vulnerabilities

.. |object-colors| image:: https://snyk.io/advisor/python/docsig/badge.svg

    :target: https://snyk.io/advisor/python/object-colors

    :alt: object-colors

Object-oriented library for stylizing terminal output

-----------------------------------------------------

Installation

------------

.. code-block:: console

    $ pip install object-colors

..

Usage

-----

Import the ``Color`` object from ``object_colors``

.. code-block:: python

    >>> from object_colors import Color

Args can be provided as strings or as indices corresponding to their index in an ANSI escape sequence

.. code-block:: python

    >>> Color(effect="bold", fore="red", back="green")

    Color(effect=1, fore=1, back=2, objects())

The following would yield the same result

.. code-block:: python

    >>> Color(effect=1, fore=1, back=2)

    Color(effect=1, fore=1, back=2, objects())

The above options are part of the below mapping

.. code-block:: python

    >>> for i, c in enumerate(Color.colors):

    ...     print(i, c)

    0 black

    1 red

    2 green

    3 yellow

    4 blue

    5 magenta

    6 cyan

    7 white

.. code-block:: python

    >>> for i, e in enumerate(Color.effects):

    ...     print(i, e)

    0 none

    1 bold

    2 dim

    3 italic

    4 underline

    5 blink

    6 blinking

    7 negative

    8 empty

    9 strikethrough

To configure the current object either ``effect``, ``fore``, or ``back`` can be provided

They must be an ``int``, ``str``, or ``None`` type

.. code-block:: python

    >>> c = Color()

    >>> c.set(effect="bold", fore="red", back="red")

    >>> c

    Color(effect=1, fore=1, back=1, objects())

Create new objects with by providing a ``dict`` object with any keyword argument

Use ``set`` to set multiple parameters

.. code-block:: python

    >>> c = Color()

    >>> c.set(bold_green=dict(effect="bold", fore="green"))

    >>> c

    Color(effect=None, fore=None, back=None, objects(bold_green))

Return ``str`` or ``tuple`` using ``get``

.. code-block:: python

    >>> c = Color()

    >>> c.set(red=dict(fore="red"))

    >>> c.set(yellow=dict(fore="yellow"))

    >>> f"{c.red.get('*')} {c.yellow.get('Warning')}"

    '\x1b[31m*\x1b[0;0m \x1b[33mWarning\x1b[0;0m'

.. code-block:: python

    >>> c = Color()

    >>> c.set(red=dict(fore="red"))

    >>> xyz = c.red.get("x", "y", "z")

    >>> xyz

    ('\x1b[31mx\x1b[0;0m', '\x1b[31my\x1b[0;0m', '\x1b[31mz\x1b[0;0m')

    >>> x, y, z = xyz

    >>> f"{x} {y} {z}"

    '\x1b[31mx\x1b[0;0m \x1b[31my\x1b[0;0m \x1b[31mz\x1b[0;0m'

Print the result using ``print``

.. code-block:: python

    >>> c = Color(effect="bold", fore="cyan")

    >>> # doctest strips ansi codes from print

    >>> c.print("bold cyan")  # '\x1b[1;36mbold cyan\x1b[0;0m'

    bold cyan

Load all ``effect``, ``fore``, or ``back`` elements using ``populate()``

.. code-block:: python

    >>> c = Color()

    >>> c.populate("fore")

    >>> c

    Color(effect=None, fore=None, back=None, objects(black, red, green, yellow, blue, magenta, cyan, white))

.. code-block:: python

    >>> c = Color()

    >>> c.set(red=dict(fore="red"))

    >>> c.red.populate("effect")

    >>> c.red

    Color(effect=None, fore=1, back=None, objects(none, bold, dim, italic, underline, blink, blinking, negative, empty, strikethrough))

    >>> # doctest strips ansi codes from print

    >>> c.red.strikethrough.print("strikethrough red")  # '\x1b[9;31mstrikethrough red\x1b[0;0m'

    strikethrough red