Skip to main content

textfx is a Python library for creating dynamic and visually engaging text effects.

Project description

Textfx

PyPI Downloads Python License Repo Size

Textfx is a Python library for creating dynamic and visually engaging text effects.
It offers multiple functions to display text with unique animations and styles — perfect for enhancing console-based projects.

Features

  • Typing Effect: Simulates the effect of typing text character by character.
  • Scramble Effect: Displays random characters that gradually transform into the actual text.
  • Wave Text: Makes the text move in a wave-like pattern.
  • Untyping Effect: Gradually erases text character by character.
  • Unscramble Effect: The text gradually scrambles into random characters until it disappears.
  • Unwave Text: The text starts in a wave-like pattern and gradually stabilizes.
  • ✅ Color Support: All effects now support colored text using termcolor.

Installation

You can install it with:

pip install textfx

Or clone this repository and use the textfx.py file directly in your project:

git clone https://github.com/iliakarimi/textfx.git
cd textfx
pip install -r requirements.txt

Then, import the required functions in your Python script:

from textfx import typeeffect, scrameffect, wavetext, untypeeffect, unscrameffect, unwavetext

Usage

Typing Effect

from textfx import typeeffect
typeeffect("Hello, world!", color="cyan", delay=0.1)

Scramble Effect

from textfx import scrameffect
scrameffect("Scrambled Text", color="green", delay=0.1)

Wave Text

from textfx import wavetext
wavetext("Wave Text", color="yellow", delay=0.1)

Untyping Effect

from textfx import untypeeffect
untypeeffect("Erasing Text", color="gray", delay=0.1)

Unscramble Effect

from textfx import unscrameffect
unscrameffect("Glitching Away", color="blue", delay=0.1)

Unwave Text

from textfx import unwavetext
unwavetext("Steadying Waves", color="red", delay=0.1)

🎨 Color Options

All effects support colored text using the color parameter.

You can choose from the following colors:

grey, red, green, yellow, blue, magenta, cyan, white

Example:

typeeffect("This is red text!", color="red", delay=0.1)

💡 Color support may depend on your terminal. Most modern terminals support termcolor outputs.

For more details, see termcolor documentation.

Dependencies

You can install the required dependencies using:

pip install -r requirements.txt

Contributing

Feel free to fork this repository and submit pull requests. Suggestions for new effects and improvements are always welcome!

License

This project is licensed under the MIT License. See the LICENSE file for details.


🎉 Enjoy using Textfx!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

textfx-2.0.0.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

textfx-2.0.0-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file textfx-2.0.0.tar.gz.

File metadata

  • Download URL: textfx-2.0.0.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for textfx-2.0.0.tar.gz
Algorithm Hash digest
SHA256 fc1cf708e457c8740a0a5b823b29b4a2dccc96cc81d82a8d0575850b22a930e4
MD5 1b2e2d552ae1372079c59c8a6c9df298
BLAKE2b-256 7ca327baf252bbebf0e2c15cc0969b98cc26c6bd124bc3e65874811d1fe23566

See more details on using hashes here.

File details

Details for the file textfx-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: textfx-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 5.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for textfx-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e36921e4b8dd9af4301f9c84324650c3b3d38b33e84fb4fd189ea506e1c15bfc
MD5 033424c0056cd548e3ba6baf4d9c6309
BLAKE2b-256 5ac6fbf956356742b52d4c2a0e49020726683946805a4656bb77b5a0e030157e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page