colourpy 0.1.0

A package inspired by simple chalk which colours terminal text with 256 Colour support

pyColour

A python function file that colours output strings.

---

Contents

1. Usage
2. Commands
   • Basic Colours
   • Bright Variants
   • Other Formatting
   • 256 Colour Support
   • Highlighting
3. Note

---

Usage

1. Install with pip install colourpy

2. Call the file into your python project with:

from pyColour import *

3. Use the following commands in your code. Text colour, background colour and formatting can be used at the same time, by stacking (e.g. `bold(red(bgGreen("Hello world!"))))

---

NOTE: the outermost colour is the colour that the text will be displayed as (e.g. in yellow(red(green("hello")))), "hello" will be displayed in yellow.

Commands

Basic Colours

colour	command
black	black(string)
red	red(string)
green	green(string)
yellow	yellow(string)
blue	blue(string)
magenta	magenta(string)
white	white(string)

Bright Variants

colour	command
bright black (grey 1)	bright_black(string)
bright red	bright_red(string)
bright green	bright_green(string)
bright yellow	bright_yellow(string)
bright blue	bright_blue(string)
bright magenta	bright_magenta(string)
bright white (grey 2)	bright_white(string)

Other Formatting

Format	Command
Bold	bold(string)
Underline	underline(string)
Reverse	reverse(string)

256 Colour support

For custom colours, use the following command: colour_256(string, [0 -> 255])

Highlighting

Highlighting is also possible, and you can use the same commands as before, just with bg infront of it (i.e. bgBlue(string), bgBright_magenta(string))

---

---

Note

This project is loosely based on the idea of Simple Chalk.

Edits

Date	Edit Description	Version
27/03/22	Edits to README.md	0.1.0