Skip to content

Latest commit

 

History

History
287 lines (187 loc) · 3.7 KB

README.md

File metadata and controls

287 lines (187 loc) · 3.7 KB
Raw

pylor

Library for outputting colorful text

Supports 16 foreground and 16 background colors

Color table

Table from Wikipedia

QuickStart

Use: pip install pylor to install the module.

Imports

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

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:

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:

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:

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:

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:

import pylor

print( pylor.reset() )

Returns string

test()

Function for testing the installation of the package, returns the project logo.

Arguments:

  • None

Example:

import pylor

print( pylor.test() )

Returns string

Codes

Colors

Foreground

colors.foreground.

red
black
green
yellow
blue
magenta
cyan
white
brightBlack
brightRed
brightGreen
brightYellow
brightBlue
brightMagenta
brightCyan
brightWhite

Background

colors.background.

red
black
green
yellow
blue
magenta
cyan
white
brightBlack
brightRed
brightGreen
brightYellow
brightBlue
brightMagenta
brightCyan
brightWhite

Decorations

decorations.

bold
underline
reverse

Cursor

cursor.

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:

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:

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:

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:

import pylor
from pylor import colors

print( pylor.color("Hello world!", colors.foreground.red, colors.background.red) )