Metadata-Version: 2.1
Name: terminalcolorpy
Version: 0.1.1
Summary: This is a simple package to print colored messages using ASCI to the terminal built with python 3
Home-page: https://github.com/ammar-sys/terminalcolorpy
Author: ammarsys
Author-email: amarftw1@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/ammar-sys/terminalcolorpy/issues
Description: # terminalcolorpy
        
        ![Open Source? Yes!](https://badgen.net/badge/Open%20Source%20%3F/Yes%21/blue?icon=github)
        
        [![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/)
        
        This is a simple package to print colored messages using ASCI to the terminal built with python 3.
        
        # Usage of terminalcolorpy
        
        
        Usage of it is pretty straight-forward,
        ```py
        from terminalcolorpy import pc
        
        print(pc('Hello', color='#42f5d7',
                 markup=['striked', 'bold', 'underline', 'italic'],
                 highlight='#a8328b')
              )
        ```
        
        TerminalColorPy has 4 main functions, 
        - prainbow
        - pcolor
        - blink
        - pcprint
        
        **prainbow** It's alias is *pr*, takes a single parameter which is text to return as rainbow.
        
        **pcolor** It's alias is *pc*, takes 4 parameteres, which are:
         - text (mandatory)
         - color (mandatory)
         - highlight 
         - markup
        
        **blink** It's alias is *b*, takes 2 parameterers, which are:
        - message (mandatory),
        - lenght (optional)
        - newMessage (optional)
        
        **pcprint** No alias, takes a single mandatory parameter pcolorSettings. Look at the examples, pcolorSettings takes a dict with values you'd pass to pcolor.
        
        Message is the string to print to the console, lenght is the how longit should stay and 
        new message is what it should be replaced with.
        
        HighLight & Color take either a string, an RGB value or even a hex code. For example,
            
        ```python
        from terminalcolorpy import pcolor, blink, pcprint
        
        print(pcolor('Hello', color='#42f5d7',
                 markup=['striked', 'bold', 'underline', 'italic'],
                 highlight='#42f5d7')
              )
        
        print(pcolor('World', color='red',
                 markup=['striked', 'bold'],
                 highlight='blue')
              )
        
        blink(pcolor('World', color=[122, 99, 0],
                 markup=['bold'],
                 highlight=[122, 100, 78])
              )
              
        pcprint(pcolorSettings={'text': 'Hello', 'color': 'red'})
        ```
        
        For more examples check **tests/tests.py** (github)
        
        # List of accepted values
        ```python
            
            # these aren't CaSe SeNsItIvE!
            
            highlight_values = [
                'gray',
                'pink',
                'black',
                'yellow',
                'green',
                'blue',
                'red'
            ]
        
            color_values = [
                'pink',
                'blue',
                'cyan',
                'green',
                'yellow',
                'red',
                'black',
                'orange'
            ]
        
            text_markup_values = [
                'bold',
                'underline',
                'italic',
                'striked'
            ]
        ```
        
        **Hex Generator** https://www.google.com/search?q=hex+color
        
        **RGB Generator** https://www.w3schools.com/colors/colors_rgb.asp
        
        It works on any terminals that support ASCII codes, include but not limited to:
        
        | Terminals      | Works On |
        | ----------- | ----------- |
        | PyCharm      | True       |
        | Python IDLE   | False        |
        | Windows CMD    | False  |
        | MacOS iTerm2         | True |
        | VSCode | True
        |  Visual Studio Code | True
        
        *i haven't really used anything else, this list is to expand*
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
