Metadata-Version: 2.2
Name: basic-colors
Version: 0.1.1
Summary: A module for printing colored text to the terminal
Home-page: https://github.com/elPytel/basic-colors
Author: elPytel
Author-email: jaroslav.korner1@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: requires-python
Dynamic: summary

# Basic colors

This Python module provides you with:
- set of variables that you can use to **color** your text in terminal,
- **logging** like messages with or without icons,
- **verbose** on/off printing.

## Installation
You can install the module using pip:
```bash
pip install basic-colors
```

## Usage
Module `basic_colors` provides you with a set of variables that you can use to color your text in terminal.

### Colored text
```python
from basic_colors import *

print(Blue + "Ahoj" + Reset)
```

### Logging like messages
```python
from basic_colors import enable_icons, print_info, print_warning, print_error, verbose_print, 

enable_icons(True)
print_info("This is an info message.")
print_warning("This is a warning message.")
print_success("This is a success message.")
print_error("This is an error message.", False)
```

```Bash
 â„ąď¸Ź  Info: This is an info message.     
âš ď¸Ź Warning: This is a warning message.
âś… Success: This is a success message.  
âťŚ Error: This is an error message.
```
*(in color)*

### Verbose print
The `set_verbose(True)` command enables verbose printing. If you want to print a message only in verbose mode, use the `verbose_print()` function.

```python
from basic_colors import set_verbose, verbose_print

set_verbose(False)
verbose_print("This is a non-verbose message.")
set_verbose(True)
verbose_print("This is a verbose message.")
```

## Sources:
- [stackoverflow.com](https://stackoverflow.com/questions/287871/how-do-i-print-colored-text-to-the-terminal)
