Metadata-Version: 2.1
Name: pylor
Version: 0.0.2
Summary: Small package made for using ANSI codes
Home-page: https://github.com/MiranDaniel/pylor
Author: MiranDaniel
Author-email: mirandanielcz@gmail.com
License: UNKNOWN
Description: # pylor
        
        ## *Library for outputting colorful text*
        
        ### Supports 16 foreground and 16 background colors
        
        ---
        
        ![Color table](https://i.stack.imgur.com/9UVnC.png)
        
        *Table from [Wikipedia](https://en.wikipedia.org/wiki/ANSI_escape_code)*
        
        ---
        
        ## QuickStart
        
        Use: `pip install pylor` to install the module.
        ### Imports
        ```py
        import pylor
        from pylor import colors # Imports class full of colors to choose from
        from pylor import decorations # Imports class full of decorations
        from pylor import cursor # Imports class for cursor movement
        ```
        
        ### Testing the installation
        
        ```py
        import pylor
        print( pylor.test() ) # This will print the project logo
        ```
        
        ---
        
        ## Functions
        
        ### **color()**
        
        The color function is used to create colored strings.
        
        Arguments:
        
        - String
        - Foreground color
        - Background color *[Optional]*
        
        **Example:**
        
        ```py
        import pylor
        from pylor import colors
        
        print( pylor.color("Hello world!", colors.foreground.red) )
        ```
        
        Returns string
        
        ---
        
        ### **colorNoReset()**
        
        The color function is used to create colored strings, does not set the color back to default (continues to color any future output).
        
        Arguments:
        
        - String
        - Foreground color
        - Background color *[Optional]*
        
        **Example:**
        
        ```py
        import pylor
        from pylor import colors
        
        print( pylor.colorNoReset("Hello world!", colors.foreground.red) )
        ```
        
        Returns string
        
        ---
        
        ### **formatting()**
        
        Function used for formatting text.
        
        Arguments:
        
        - String
        - Formatting type
        
        **Example:**
        
        ```py
        import pylor
        from pylor import decorations
        
        print( pylor.formatting("Hello world!", decorations.bold) )
        ```
        
        Returns string
        
        ---
        
        ### **formattingNoReset()**
        
        Function used for formatting text, does not set the color back to default (continues to decorate any future output).
        
        Arguments:
        
        - String
        - Formatting type
        
        **Example:**
        
        ```py
        import pylor
        from pylor import decorations
        
        print( pylor.formatting("Hello world!", decorations.bold) )
        ```
        
        Returns string
        
        ---
        
        ### **reset()**
        
        Function used for resetting the color after using colorNoReset()
        
        Arguments:
        
        - None
        
        **Example:**
        
        ```py
        import pylor
        
        print( pylor.reset() )
        ```
        
        Returns string
        
        ---
        
        ### **test()**
        
        Function for testing the installation of the package, returns the project logo.
        
        Arguments:
        
        - None
        
        **Example:**
        
        ```py
        import pylor
        
        print( pylor.test() )
        ```
        
        Returns string
        
        ---
        
        ## Codes
        
        ### **Colors**
        
        #### **Foreground**
        
        *colors.foreground.*
        
        ```md
        red
        black
        green
        yellow
        blue
        magenta
        cyan
        white
        brightBlack
        brightRed
        brightGreen
        brightYellow
        brightBlue
        brightMagenta
        brightCyan
        brightWhite
        ```
        
        #### **Background**
        
        *colors.background.*
        
        ```md
        red
        black
        green
        yellow
        blue
        magenta
        cyan
        white
        brightBlack
        brightRed
        brightGreen
        brightYellow
        brightBlue
        brightMagenta
        brightCyan
        brightWhite
        ```
        
        ---
        
        ### **Decorations**
        
        *decorations.*
        
        ```md
        bold
        underline
        reverse
        ```
        
        ### **Cursor**
        
        *cursor.*
        
        ```md
        up
        down
        right
        left
        ```
        
        ## Exceptions
        
        ### NotAColor
        
        Exception for when the argument given is not an ANSI code.
        
        Example of code that would trigger this Exception:
        
        ```py
        import pylor
        from pylor import colors
        
        print( pylor.color("Hello world!", "red") ) # This is an example of bad code, do not use this, it will not work.
        ```
        
        correct code:
        
        ```py
        import pylor
        from pylor import colors
        
        print( pylor.color("Hello world!", colors.foreground.red) )
        ```
        ---
        
        ### SameType
        
        Exception for when the background/foreground colors are used twice.
        
        Example of code that would trigger this Exception:
        
        ```py
        import pylor
        from pylor import colors
        
        print( pylor.color("Hello world!", colors.foreground.red, colors.foreground.green) ) # This is an example of bad code, do not use this, it will not work.
        ```
        
        correct code:
        
        ```py
        import pylor
        from pylor import colors
        
        print( pylor.color("Hello world!", colors.foreground.red, colors.background.red) )
        ```
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
