Metadata-Version: 2.1
Name: pywriter
Version: 0.1.1
Summary: Typewriter effect for python
Home-page: https://github.com/amarquaye/pywriter
Author: Jesse Amarquaye
Author-email: jesseamarquayelegendary@gmail.com
Keywords: python,pywriter,type,writer,typewriter,typewritereffect
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Printing
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# Pywriter

Pywriter is a Python module for printing text to your console or terminal in the classic typewriter effect.

## Installation

Use the package manager [pip](https://pip.pypa.io/en/stable/) to install pywriter.

```bash
pip install pywriter
```


## Usage

```python
import pywriter

# returns 'Hello World!' character by character at the rate of one character per second
pywriter.write('Hello World!', rate=1)



# You can decide to exclude the rate argument.
# That will print out your text at the default rate of 0.1


```

## Alternate Usage
```python
from pywriter import write

# returns 'Hello World!' character by character at the rate of one character per second
write('Hello World!', rate=1)



# However, it is recommended that you use pywriter.write instead of using the write function directly.
# Since this will help prevent any conflict in case there is another python module which also has a write function.

```
<br/>

## Demo

![ui_glow_up](https://user-images.githubusercontent.com/96346994/233510322-9397b5b3-8626-447a-9453-0e580beae656.gif)

<br/>

## Changelog

### v0.1.1 (21/04/2023)

### Feature

- First minor update of `pywriter`
- Added compatibility with terminal and any console.

### Fix

- Fixed issue with windows cmd waiting for the entire program to run before output in seen.


### v0.0.1 (15/04/2023)

- First release of `pywriter`

<br/>

## Contributing

Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License

[MIT](https://github.com/amarquaye/pywriter/blob/master/LICENSE)


## Authors

- [Jesse Amarquaye](https://www.github.com/amarquaye)


## Roadmap

- Add more integrations.

<br/>

## About Me

- 👨‍💻 All of my projects are available at [https://www.github.com/amarquaye](https://www.github.com/amarquaye)

- 📫 How to reach me via mail **jesseamarquayelegendary@gmail.com**

<h2 align="left">Connect with me:</h2>
<p align="left">
<a href="https://twitter.com/llordjesse" target="blank"><img align="center" src="https://raw.githubusercontent.com/rahuldkjain/github-profile-readme-generator/master/src/images/icons/Social/twitter.svg" alt="llordjesse" height="30" width="40" /></a>
<a href="https://linkedin.com/in/amarquaye" target="blank"><img align="center" src="https://raw.githubusercontent.com/rahuldkjain/github-profile-readme-generator/master/src/images/icons/Social/linked-in-alt.svg" alt="amarquaye" height="30" width="40" /></a>
<a href="https://fb.com/llordjesse" target="blank"><img align="center" src="https://raw.githubusercontent.com/rahuldkjain/github-profile-readme-generator/master/src/images/icons/Social/facebook.svg" alt="llordjesse" height="30" width="40" /></a>
<a href="https://instagram.com/llordjesse" target="blank"><img align="center" src="https://raw.githubusercontent.com/rahuldkjain/github-profile-readme-generator/master/src/images/icons/Social/instagram.svg" alt="llordjesse" height="30" width="40" /></a>
</p>


## Feedback

If you have any feedback, please reach out to us at jesseamarquayelegendary@gmail.com
