https://github.com/amarquaye/pywriter
👨‍💻Typewriter effect for python!
https://github.com/amarquaye/pywriter
console modules python pywriter terminal type typewriter
Last synced: 22 days 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 3 years ago)
- Default Branch: master
- Last Pushed: 2024-02-23T15:50:48.000Z (over 2 years ago)
- Last Synced: 2024-04-24T17:41:22.704Z (about 2 years 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
[](https://www.python.org/)
[](https://www.python.org/downloads/)
[](https://pypi.org/project/pywriter/)
[](https://pepy.tech/project/pywriter)
[](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.reverse('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.01
```
## Alternate Usage
```python
from pywriter import write, reverse, 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
reverse('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
## 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:engineeramarquaye@gmail.com).
Connect with me:
## Feedback
If you have any feedback, please [reach out to me](mailto:engineeramarquaye@gmail.com).
## Disclaimer
Pywriter is provided as-is and does not require frequent updates. While it remains functional and usable, future updates will be made only if necessary. If you find the project useful but notice a lack of recent activity, this **does not mean it is abandoned**. Contributions are welcome via pull requests.