Metadata-Version: 2.1
Name: tcolorpy
Version: 0.0.8
Summary: tcolopy is a Python library to apply true color for terminal text.
Home-page: https://github.com/thombashi/tcolorpy
Author: Tsuyoshi Hombashi
Author-email: tsuyoshi.hombashi@gmail.com
License: MIT License
Project-URL: Source, https://github.com/thombashi/tcolorpy
Project-URL: Tracker, https://github.com/thombashi/tcolorpy/issues
Description: .. contents:: **tcolorpy**
           :backlinks: top
           :depth: 2
        
        
        Summary
        ============================================
        tcolopy is a Python library to apply true color for terminal text.
        
        .. image:: https://badge.fury.io/py/tcolorpy.svg
            :target: https://badge.fury.io/py/tcolorpy
            :alt: PyPI package version
        
        .. image:: https://img.shields.io/pypi/pyversions/tcolorpy.svg
            :target: https://pypi.org/project/tcolorpy
            :alt: Supported Python versions
        
        .. image:: https://img.shields.io/pypi/implementation/tcolorpy.svg
            :target: https://pypi.org/project/tcolorpy
            :alt: Supported Python implementations
        
        .. image:: https://img.shields.io/travis/thombashi/tcolorpy/master.svg?label=Linux/macOS%20CI
            :target: https://travis-ci.org/thombashi/tcolorpy
            :alt: Linux/macOS CI status
        
        .. image:: https://img.shields.io/appveyor/ci/thombashi/tcolorpy/master.svg?label=Windows%20CI
            :target: https://ci.appveyor.com/project/thombashi/tcolorpy/branch/master
            :alt: Windows CI status
        
        .. image:: https://codecov.io/gh/thombashi/tcolorpy/branch/master/graph/badge.svg
            :target: https://codecov.io/gh/thombashi/tcolorpy
            :alt: Test coverage: codecov
        
        
        Installation
        ============================================
        ::
        
            pip install tcolorpy
        
        
        Usage
        ============================================
        
        Library usage
        --------------------------------------------
        
        :Sample Code:
            .. code-block:: python
        
                from tcolorpy import tcolor
        
                print(tcolor("tcolopy example", color="#ee1177", styles=["bold", "italic", "underline"]))
        
        :Output:
            .. figure:: https://cdn.jsdelivr.net/gh/thombashi/tcolorpy@master/ss/oneline.png
                :scale: 60%
                :alt: https://github.com/thombashi/tcolorpy/blob/master/ss/oneline.png
        
        You can set the following ``tcolor`` arguments:
        
        - ``color``/``bg_color``
            - color names (``"red"``, ``"red"``, etc.) or color code (``"#RRGGBB"``)
        - ``styles``
            - ``"bold"``, ``"italic"``, etc.
        
        
        Other examples
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        Apply true color and styles to text:
        
        .. figure:: https://cdn.jsdelivr.net/gh/thombashi/tcolorpy@master/ss/styles.png
            :scale: 60%
            :alt: https://github.com/thombashi/tcolorpy/blob/master/ss/styles.png
        
            `tcolorpy/ansi_styles.py <https://github.com/thombashi/tcolorpy/blob/master/examples/ansi_styles.py>`__
        
        You can also specify colors by names:
        
        .. figure:: https://cdn.jsdelivr.net/gh/thombashi/tcolorpy@master/ss/ansi_colors.png
            :scale: 60%
            :alt: https://github.com/thombashi/tcolorpy/blob/master/ss/ansi_colors.png
        
            `tcolorpy/ansi_colors.py <https://github.com/thombashi/tcolorpy/blob/master/examples/ansi_colors.py>`__
        
        
        CLI usage
        --------------------------------------------
        ``tcolorpy`` can be used via CLI:
        
        ::
        
            $ python -m tcolorpy "tcolopy example" -c "#ee1177" -s bold,italic,underline
        
        Command help
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        ::
        
            usage: __main__.py [-h] [-c COLOR] [-b BG_COLOR] [-s STYLES] [--encode ENCODE]
                               string
        
            positional arguments:
              string                string to apply styles.
        
            optional arguments:
              -h, --help            show this help message and exit
              -c COLOR, --color COLOR
                                    specify a color code (#XXXXXX) or a name. valid names
                                    are: black, red, green, yellow, blue, magenta, cyan,
                                    white, lightblack, lightred, lightgreen, lightyellow,
                                    lightblue, lightmagenta, lightcyan, lightwhite
              -b BG_COLOR, --bg-color BG_COLOR
                                    specify a background color code (#XXXXXX) or a name.
                                    valid names are: black, red, green, yellow, blue,
                                    magenta, cyan, white, lightblack, lightred,
                                    lightgreen, lightyellow, lightblue, lightmagenta,
                                    lightcyan, lightwhite
              -s STYLES, --styles STYLES
                                    specify a comma separated styles. valid values are:
                                    bold, dim, italic, underline, blink, invert, strike
              --encode ENCODE       output a text encoded with the specified encoding
        
        
        Dependencies
        ============================================
        Python 3.5+
        No external dependencies.
        
Keywords: ANSI escape,terminal color,truecolor
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Terminals
Classifier: Topic :: Text Processing
Requires-Python: >=3.5
Description-Content-Type: text/x-rst
Provides-Extra: test
