# 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)
# Let's introduce my latest features
pywriter.writer('Hello World!', rate=1)
pywriter.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.1
```
## 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.
```
<br/>
## Demo
<br/>
## Changelog
### v1.0.0 (29/06/2023)
### Feature
- First major update of `pywriter`
- Added function to print output with typewriter effect in reverse.
The name of this new function is ```writer```.
- Also added function to print output with typewriter effect.
In a way that it deletes some part of the text to some index and prints another text to replace the previous text.
And name of my most recent and favourite function is ```typewwriter```.
### 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
[AGPL v3.0](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
Raw data
{
"_id": null,
"home_page": "https://github.com/amarquaye/pywriter",
"name": "pywriter",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "python,pywriter,type,writer,typewriter,typewritereffect",
"author": "Jesse Amarquaye",
"author_email": "jesseamarquayelegendary@gmail.com",
"download_url": "",
"platform": null,
"description": "# Pywriter\r\n\r\nPywriter is a Python module for printing text to your console or terminal in the classic typewriter effect.\r\n\r\n## Installation\r\n\r\nUse the package manager [pip](https://pip.pypa.io/en/stable/) to install pywriter.\r\n\r\n```bash\r\npip install pywriter\r\n```\r\n\r\n\r\n## Usage\r\n\r\n```python\r\nimport pywriter\r\n\r\n# returns 'Hello World!' character by character at the rate of one character per second\r\npywriter.write('Hello World!', rate=1)\r\n\r\n# Let's introduce my latest features\r\npywriter.writer('Hello World!', rate=1)\r\npywriter.typewriter('Hello World!', new=\"Jesse\", idx=6, rate=1)\r\n\r\n\r\n\r\n# You can decide to exclude the rate argument.\r\n# That will print out your text at the default rate of 0.1\r\n\r\n\r\n```\r\n\r\n## Alternate Usage\r\n```python\r\nfrom pywriter import write, writer, typewriter\r\n\r\n# returns 'Hello World!' character by character at the rate of one character per second\r\nwrite('Hello World!', rate=1)\r\n\r\n# Let's introduce my latest features\r\nwriter('Hello World!', rate=1)\r\ntypewriter('Hello World!', new=\"Jesse\", idx=6, rate=1)\r\n\r\n\r\n# However, it is recommended that you use pywriter.write\r\n#instead of using the write function directly.\r\n# Since this will help prevent any conflict in case there\r\n#is another python module which also has a write function.\r\n\r\n```\r\n<br/>\r\n\r\n## Demo\r\n\r\n\r\n\r\n<br/>\r\n\r\n## Changelog\r\n\r\n### v1.0.0 (29/06/2023)\r\n\r\n### Feature\r\n\r\n- First major update of `pywriter`\r\n- Added function to print output with typewriter effect in reverse.\r\n The name of this new function is ```writer```.\r\n- Also added function to print output with typewriter effect.\r\n In a way that it deletes some part of the text to some index and prints another text to replace the previous text.\r\n And name of my most recent and favourite function is ```typewwriter```.\r\n\r\n\r\n### v0.1.1 (21/04/2023)\r\n\r\n### Feature\r\n\r\n- First minor update of `pywriter`\r\n- Added compatibility with terminal and any console.\r\n\r\n### Fix\r\n\r\n- Fixed issue with windows cmd waiting for the entire program to run before output in seen.\r\n\r\n\r\n### v0.0.1 (15/04/2023)\r\n\r\n- First release of `pywriter`\r\n\r\n<br/>\r\n\r\n## Contributing\r\n\r\nPull requests are welcome. For major changes, please open an issue first\r\nto discuss what you would like to change.\r\n\r\nPlease make sure to update tests as appropriate.\r\n\r\n## License\r\n\r\n[AGPL v3.0](https://github.com/amarquaye/pywriter/blob/master/LICENSE)\r\n\r\n\r\n## Authors\r\n\r\n- [Jesse Amarquaye](https://www.github.com/amarquaye)\r\n\r\n\r\n## Roadmap\r\n\r\n- Add more integrations.\r\n\r\n<br/>\r\n\r\n## About Me\r\n\r\n- \ud83d\udc68\u200d\ud83d\udcbb All of my projects are available at [https://www.github.com/amarquaye](https://www.github.com/amarquaye)\r\n\r\n- \ud83d\udceb How to reach me via mail **jesseamarquayelegendary@gmail.com**\r\n\r\n<h2 align=\"left\">Connect with me:</h2>\r\n<p align=\"left\">\r\n<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>\r\n<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>\r\n<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>\r\n<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>\r\n</p>\r\n\r\n\r\n## Feedback\r\n\r\nIf you have any feedback, please reach out to us at jesseamarquayelegendary@gmail.com\r\n",
"bugtrack_url": null,
"license": "",
"summary": "Typewriter effect for python",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/amarquaye/pywriter"
},
"split_keywords": [
"python",
"pywriter",
"type",
"writer",
"typewriter",
"typewritereffect"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fa6ca24e13e9a7efe1451fcd966626a3ae8dc0d741597c46465c84014f7b3c0d",
"md5": "f7fd941cb1f242dd7e627f877b6aac39",
"sha256": "8db34a8aabc4c23679bfaba9edbecf50cb074c554d201ee43043f58345f1519d"
},
"downloads": -1,
"filename": "pywriter-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f7fd941cb1f242dd7e627f877b6aac39",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 15653,
"upload_time": "2023-06-29T00:34:48",
"upload_time_iso_8601": "2023-06-29T00:34:48.702523Z",
"url": "https://files.pythonhosted.org/packages/fa/6c/a24e13e9a7efe1451fcd966626a3ae8dc0d741597c46465c84014f7b3c0d/pywriter-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-29 00:34:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "amarquaye",
"github_project": "pywriter",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pywriter"
}
JSON
