Metadata-Version: 2.1
Name: snail-print
Version: 0.1.6
Summary: A print funtion that slowly shows the output in console in real time
Home-page: https://github.com/Baelfire18/snail_print
License: MIT
Keywords: print,console,realtime,slowly
Author: Jose Antonio Castro
Author-email: jacastro18@uc.cl
Requires-Python: >=3.7,<4.0
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Project-URL: Repository, https://github.com/Baelfire18/snail_print
Description-Content-Type: text/markdown

# Snail Print

[![GitHub release](https://img.shields.io/github/v/release/Baelfire18/slow_print.svg)](../../releases/latest)
<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>

This library includes a print funtion that slowly shows the output in console in real time.



Moreover, every console log in this video was made with the library and with [this file](https://github.com/Baelfire18/snail_print/master/presentation.py)

## Getting started

Install the library with:

```sh
pip install -U snail_print
```

### Usage

![Presentation Demo Video](https://raw.githubusercontent.com/Baelfire18/snail_print/master/assets/presentacion_color.gif)

*Video 1: Example of use of this real life print library*

## Documentation

### snail_print

```python
function snail_print(*objects, delay=0.1, sep=" ", end="\n", flush=False)
```

#### Parameters

+ `objects`: Can be any python object.

The object wicth will be printed slowly in real time.

+ `delay`: `float` or `int`, default `0.1`.

The time between the addition in console of the next character.

+ `sep`: `str`, default `" "`.

In case of having mutiple arguments this may be separated by this string.

+ `end`: `str`, default `"\n"`.

The final character of the print. By default creates a new line.


## Testing

Run the test suite with:

```sh
python -m unittest tests
```

## Install Local

To install it locally from the source code:

```sh
python setup.py develop
```

