Easily print colored text.
Project description
# CliRAINBOW
Easily print colored text.
## Example usage
```python
>>> from clirainbow import Colorizer, RED, GREEN
>>> c = Colorizer()
>>> c.print('<hello> <world!>', RED, GREEN)
```
## Additional info
* If you want to insert a literal bracket, double it (e.g. write `<<` instead of `<`)
* (this is the same behavior as Python's builtins)
* Angle brackets are used instead of the traditional curly brackets in order to prevent clashes with Python's builtin string formatting facilities
## Exceptions
At the moment, three possible exceptions may occur while using the library :
1. A color bracket is opened, but never closed (`ColorBracketOpenedButNotClosed`)
2. More brackets than colors are given (`MoreBracketsThanColors`)
3. More colors than brackets are given (`MoreColorsThanBrackets`)
In each case, a readable error message is produced
## Disclaimer
Colors may not appear on certain systems (e.g., Windows) or with certain terminals.
## Dependencies
CliRAINBOW is built on top of colorama : https://github.com/tartley/colorama
## Future plans
* Generate code in `colors.py` with a script instead of at runtime
* Allow code completion
* Remove annoying error messages
* Add support for reusing colors by index, e.g. `c.print('<0:oh> <1:hai> <0:there>', colors.RED, colors.BLACK)`
* Make it more similar to Python's `format`
Easily print colored text.
## Example usage
```python
>>> from clirainbow import Colorizer, RED, GREEN
>>> c = Colorizer()
>>> c.print('<hello> <world!>', RED, GREEN)
```
## Additional info
* If you want to insert a literal bracket, double it (e.g. write `<<` instead of `<`)
* (this is the same behavior as Python's builtins)
* Angle brackets are used instead of the traditional curly brackets in order to prevent clashes with Python's builtin string formatting facilities
## Exceptions
At the moment, three possible exceptions may occur while using the library :
1. A color bracket is opened, but never closed (`ColorBracketOpenedButNotClosed`)
2. More brackets than colors are given (`MoreBracketsThanColors`)
3. More colors than brackets are given (`MoreColorsThanBrackets`)
In each case, a readable error message is produced
## Disclaimer
Colors may not appear on certain systems (e.g., Windows) or with certain terminals.
## Dependencies
CliRAINBOW is built on top of colorama : https://github.com/tartley/colorama
## Future plans
* Generate code in `colors.py` with a script instead of at runtime
* Allow code completion
* Remove annoying error messages
* Add support for reusing colors by index, e.g. `c.print('<0:oh> <1:hai> <0:there>', colors.RED, colors.BLACK)`
* Make it more similar to Python's `format`
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
clirainbow-1.2.0.tar.gz
(3.7 kB
view details)
Built Distribution
File details
Details for the file clirainbow-1.2.0.tar.gz
.
File metadata
- Download URL: clirainbow-1.2.0.tar.gz
- Upload date:
- Size: 3.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9e08075c7e2d7449c38fd180a4d04b6c81358cc3f738c4351e28a78e8c4bb455 |
|
MD5 | 9745a4a4f7495ecc86c7c400b76e6f20 |
|
BLAKE2b-256 | 95eefffd2a639b3547bef3a5059fe772ad9d476e3458b2e3885c20cee3654b46 |
File details
Details for the file clirainbow-1.2.0-py3-none-any.whl
.
File metadata
- Download URL: clirainbow-1.2.0-py3-none-any.whl
- Upload date:
- Size: 6.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 328db8c31bc4380579a08d5a73e5379c1f9db27d8055889bfa5d2862b51219e5 |
|
MD5 | fc6c07a3891abf50d462bdc806c6d601 |
|
BLAKE2b-256 | 2479c5d4183b9cf1fe283d9c61863e6f5e1a4bad2a7c3ebe35c97a9ba07fdfbc |