Metadata-Version: 2.1
Name: rainbow-print
Version: 1.0.2
Summary: Rainbow Print adds colors to the standard outputs to ease the process of monitoring respective data / metrics
Home-page: https://github.com/kingspp/rainbow-print
Author: Prathyush SP
Author-email: kingspprathyush@gmail.com
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/kingspp/rainbow-print/issues
Project-URL: Funding, https://donate.pypi.org
Project-URL: Say Thanks!, https://saythanks.io/to/kingspprathyush@gmail.com
Project-URL: Source, https://github.com/kingspp/rainbow-print
Description: <!-- Start of Badges -->
        ![version badge](https://img.shields.io/badge/rainbow--print%20version-0.0.0-green.svg)
        ![build](https://github.com/kingspp/rainbow-print/workflows/Release/badge.svg)
        ![coverage badge](https://img.shields.io/badge/coverage-0.00%25|%200.0k/0k%20lines-green.svg)
        ![test badge](https://img.shields.io/badge/tests-0%20total%7C0%20%E2%9C%93%7C0%20%E2%9C%98-green.svg)
        ![docs badge](https://img.shields.io/badge/docs-none-green.svg)
        ![commits badge](https://img.shields.io/badge/commits%20since%20v0.0.0-0-green.svg)
        ![footprint badge](https://img.shields.io/badge/mem%20footprint%20-0.00%20Mb-green.svg)
        [![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/kingspprathyush@gmail.com)
        <!-- End of Badges -->
        
        # Rainbow Print
        
        Inspired by Rainbow CSV - **Rainbow Print** adds colors to the standard outputs to ease the process of monitoring respective data / metrics
        
        ## Main features
        
        * Highlights data points in different colors to ease monitoring capabilities
        * By default provides 7 colors (light and dark each) for N Variables(rolling). Supports N colors 
        * Support for Dark and Light backgrounds
        * Supports string print based on separator / dictionary's key-value based print
        * Supports custom colors based on ``sty.fg`` package
        * Supports use of python logging frameword for advance usecases
        
        ## Demo 
        
        How rainbow print helps
        
        ### Default print a dictionary of metrics for 10 steps
        ![Dict Print](https://github.com/kingspp/rainbow-print/blob/master/assets/print_dict.png?raw=true)
        ### Default print a string of metrics for 10 steps
        ![Str Print](https://github.com/kingspp/rainbow-print/blob/master/assets/print_str.png?raw=true)
        ### Rainbow Print - Dark Mode
        ![Rainbow Print Dark](https://github.com/kingspp/rainbow-print/blob/master/assets/printr-dark.png?raw=true)
        ### Rainbow Print - Light Mode
        ![Rainbow Print Light](https://github.com/kingspp/rainbow-print/blob/master/assets/printr-light.png?raw=true)
        
        ## Requirements
        1. python >3
        2. sty
        
        ## Installation
        ```bash
        pip install rainbow-print
        ```
        
        ## Usage
        ```python
        # Print
        from rainbow_print import printr
        data = {"Episode": 10, "Episode Len":5, "Cost": 0.95, "Reward":135, "Mode":"Explore"}
        printr(data)
        ```
        ![printr dict](https://github.com/kingspp/rainbow-print/blob/master/assets/printr-dict-1.png?raw=true)
        ```python
        data = f"Episode:{10}, Episode Len:{5}, Cost:{0.95}, Reward:{135}, Mode:{'Explore'}"
        printr(data, sep=',')
        ```
        ![printr str](https://github.com/kingspp/rainbow-print/blob/master/assets/printr-str-1.png?raw=true)
        ```python
        # Logging
        from rainbow_print import rlogging
        logger = rlogging.getLogger(__name__)
        data = {"Episode": 10, "Episode Len":5, "Cost": 0.95, "Reward":135, "Mode":"Explore"}
        logger.info(data)
        ```
        ![logger dict](https://github.com/kingspp/rainbow-print/blob/master/assets/logger-dict-1.png?raw=true)
        ```python
        data = f"Episode:{10}, Episode Len:{5}, Cost:{0.95}, Reward:{135}, Mode:{'Explore'}"
        logger.debug(data, sep=',')
        ```
        ![logger str](https://github.com/kingspp/rainbow-print/blob/master/assets/logger-str-1.png?raw=true)
        ```python
        # Get information regarding current configuration
        printr.info()
        >>Theme: dark
        >>Colors: ['\x1b[38;2;5;152;154m', '\x1b[38;2;116;162;103m', '\x1b[38;2;179;128;168m', '\x1b[38;2;255;127;0m', '\x1b[38;2;112;154;180m', '\x1b[38;2;255;255;0m', '\x1b[38;2;255;0;0m']
        ```
        
        ## Configuration
        ```python
        # By default printr works in dark mode
        from rainbow_print import printr
        
        # Switch to light palette
        printr.set_light_palette()
        
        # Switch to dark palette
        printr.set_dark_palette()
        
        # Set colors for dark palette
        colors = [sty.fg(0,0,0), sty.fg(255,255,255)]
        printr.update_dark_palette(colors)
        
        # Set colors for light palette
        colors = [sty.fg(0,0,0), sty.fg(255,255,255)]
        printr.update_light_palette(colors)
        ```
        
Keywords: rainbow_print,print,logging,colors
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.5, <4
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: test
