https://github.com/amarquaye/pywriter

👨‍💻Typewriter effect for python!
https://github.com/amarquaye/pywriter

console modules python pywriter terminal type typewriter

Last synced: 4 months ago
JSON representation

👨‍💻Typewriter effect for python!

• Host: GitHub
• URL: https://github.com/amarquaye/pywriter
• Owner: amarquaye
• License: mit
• Created: 2023-04-15T02:56:14.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-02-23T15:50:48.000Z (over 1 year ago)
• Last Synced: 2024-04-24T17:41:22.704Z (about 1 year ago)
• Topics: console, modules, python, pywriter, terminal, type, typewriter
• Language: Python
• Homepage: https://www.amarquaye.ml
• Size: 2.85 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG
  • Contributing: docs/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Pywriter

[![Python](https://img.shields.io/badge/Python-3776AB?style=for-the-badge&logo=python&logoColor=white)](https://www.python.org/)

[![Badge](https://img.shields.io/badge/python-3.x-color.svg)](https://www.python.org/downloads/)

[![PyPI](https://img.shields.io/pypi/v/pywriter.svg)](https://pypi.org/project/pywriter/)

[![Downloads](https://static.pepy.tech/badge/pywriter)](https://pepy.tech/project/pywriter)

[![GitHub](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white)](https://github.com/amarquaye/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 as pw

# returns 'Hello World!' character by character at the rate of one character per second

pw.write('Hello World!', rate=1)

# Let's introduce my latest features

pw.writer('Hello World!', rate=1)

pw.typewriter('Hello World!', new="Jesse", idx=6, rate=1)

# You can decide to exclude the rate argument.

# That will print out your text at the default rate of 0.035

```

## Alternate Usage

```python

from pywriter import write, writer, typewriter

# returns 'Hello World!' character by character at the rate of one character per second

write('Hello World!', rate=1)

# Let's introduce my latest features

writer('Hello World!', rate=1)

typewriter('Hello World!', new="Jesse", idx=6, 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.

```

## Demo

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

## Contributing

Pull requests are welcome. For major changes, please open an issue first

to discuss what you would like to change.

## License

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

## Authors

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

## Roadmap

- Adding more features soon.

## About Me

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

- 📫 You can reach me via [mail](mailto:[email protected]).

Connect with me:













## Feedback

If you have any feedback, please reach out to [me](mailto:[email protected]).