Metadata-Version: 2.1
Name: beautiful-console
Version: 0.9
Summary: A package for print beautiful logs in console.
Home-page: https://github.com/pourya90091/beautiful-console
Author: pourya90091
Author-email: pourya90091@gmail.com
Project-URL: Bug Tracker, https://github.com/pourya90091/beautiful-console/issues
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
License-File: LICENSE

# Beautiful Console

## Installation

### Install

```bash
pip install beautiful-console
```

### Import

```python
from beautiful_console import beautiful_console as bc
```

## Defined Colors

>black, red, green, yellow, blue, magenta, cyan, white

## Defined Styles

>**bold**, _italic_, underline, underline_bold, overline, ~~strikethrough~~

<br>

## beautiful_console() Parameters

```python
# Only the text-parameter is required, then you can use any option you need.

"""
text: A text.
text_color: Color of the text.
text_style: Style of the text.
text_highlight_color: Color of the text background.
text_blink: Blinking the text <True or False>.
continuous_color: Color of continuous text (when typing input).
continuous_style: Style of continuous text.
continuous_highlight_color: Color of continuous text background.
continuous_blink: Blinking continuous text <True or False>.
text_color_degree: Intensity of the text color <0 or 1>
text_highlight_color_degree: Intensity of text background color <0 or 1>
continuous_color_degree: Intensity of continuous text color <0 or 1>
continuous_highlight_color_degree: Intensity of continuous text background color <0 or 1>
get_input: To use continuous text options it must be True, then beautiful_console() handle a input-function and returns input value.
"""
```

## Tips

>**Tip** : Some things may not work on some consoles.
>**Tip** : get_input can only be filled as a keyword argument (get_input=True).
---
