A small package to make printing pretty things easier!
Project description
ThrowColour
ThrowColour is a small Python module to make printing messages with formatting and colours easier! This module is mostly just practice with creating a working pip module for learning purposes.
Features
- Supports different types of print messages with colour coding
- Support basic formatting (bold, italics)
- Supports timestamp printing
Usage
Getting it
To download throwcolour, either fork this Github repo or simply use Pypi via pip.
$ pip install ThrowColour
Using it
A few functional examples of how to use ThrowColour.
Basic Functionality
A basic example of how to use the cthrow
function.
from ThrowColour import cthrow
cthrow('Test 1,2')
This would print the message DATETIME - [INFO] Test 1,2
in a nice looking purple with DATETIME
replaced with the current timestamp.
The cthrow
function
The full cthrow
function is as follows:
cthrow(message, type='INFO', formatting=None, addPrefix=True, dateTime=True)
Setting the type
argument
As you can see, a flag can be specified. This specifies the colour of the message and the message type. When setting flags, ensure the strings match exactly the name of the flag detailed below.
- INFO - A nice aesthetic purple message
- OK - A satisfying green message
- WARN - A cautionary yellow message
- ERR - A not-so-good red message
For example:
cthrow("This probably isn't good", type="WARN")
The addPrefix
and dateTime
arguments
We can also disable the prefix (the stuff inside the []) and timestamp as follows.
cthrow("Look Mom, no prefix and timestamp!", addPrefix=False, dateTime=False)
Setting formatting flags
With ThrowColour it is also possible to set multiple formatting flags such as bold and italics. It is important to note that the argument formatting
takes a list containing strings of different formatting options.
cthrow("Bold and Underlined", formatting=['BOLD','UNDERLINE'])
Or just bolded,
cthrow("Nice and bold", formatting=['BOLD'])
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ThrowColour_jzhao-1.0.4-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5cd4a8a44f41a0c9edcbe85e8e77be395fb8c6a01105e55a94f464386f7e8fe9 |
|
MD5 | d7a605b9657a5d230601568b5afa66a7 |
|
BLAKE2b-256 | 861072f92b4bc1ddfc04c3e7cc01d04eca0f9a1dd0330a65e7dc6ff6710db0a4 |