Metadata-Version: 2.1
Name: c-print
Version: 1.0.1
Summary: Small python package for printing text in different colours and typography.
Home-page: https://github.com/SimonPfeifer/cprint
Author: Simon Pfeifer
Author-email: s.pfeifer@2012.ljmu.ac.uk
License: UNKNOWN
Platform: UNKNOWN
Description-Content-Type: text/markdown

# cprint
Small python package for printing text in different colours and typography.

### Installation

pip install c-print

### Prerequisites

You need to have a Python2.7+ or Python3+ installation with the following libraries:

### Usage

The `cprint()` function simply adds one keyword argument, `c`, to the python `print()` function. This extra keyword argument can change the output of `print()` to one colour and any number of given styles. Colours are given in lower case and styles in upper case. Any other keyword arguments are passed on to `print()`.

| Character  |  Colour         |
| ---------- | --------------- |
| 'k'        | black           |
| 'r'        | red             |
| 'g'        | green           |
| 'y'        | yellow          |
| 'b'        | blue            |
| 'm'        | magenta         |
| 'c'        | cyan            |
| 'w'        | white           |

| Character  | Style           |
| ---------- | --------------- |
| 'B'        | bold            |
| 'D'        | dark            |
| 'I'        | italic          |
| 'U'        | underline       |
| 'F'        | flash           |
| 'R'        | reverse colour  |
| 'C'        | crossed through |

Example:
```python
from cprint import cprint
cprint('Hello World!', c='rB')
cprint('Hello World!', 'Monty Python', c='bUI', end='!')
```


