textfx 2.2

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

Textfx v2.2

Textfx is a lightweight Python library for creating dynamic, visually engaging console text effects.

What’s New in v2.2

• Loading Animations: Added three new context‑managed loader classes:

  1. SpinnerLoading (classic spinning cursor)
  2. ProgressBarLoading (animated bar moving back and forth)
  3. GlitchLoading (random-character glitch effect)

• API Consistency: All loaders share the same initialization parameters and with-syntax.

• Examples Moved: Detailed usage examples are now located in docs/examples.md for a cleaner README.

Installation

pip install textfx

Or clone & install dependencies:

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

Features

1. Typing Effect (typeeffect)
2. Scramble Effect (scrameffect)
3. Wave Text (wavetext)
4. Untyping Effect (untypeeffect)
5. Unscramble Effect (unscrameffect)
6. Unwave Text (unwavetext)
7. Loading Animations (more new loading in v2.2)
8. ✅ Color Support via termcolor

Usage

Import the desired effects and loaders:

from textfx import (
    typeeffect, scrameffect, wavetext,
    untypeeffect, unscrameffect, unwavetext,
    SpinnerLoading, ProgressBarLoading, GlitchLoading
)

For detailed examples, see docs/examples.md.

Loading Animations

All loader classes share these parameters:

• message (str): Prefix text displayed before the animation.
• end_message (str): Text displayed after the loader stops.
• delay (float): Seconds between animation frames.

1. SpinnerLoading

Classic spinner cursor:

with SpinnerLoading(
    message="Processing...",
    animation="⠋⠙⠸⠴⠦⠇",
    delay=0.1
):
    do_work()

2. ProgressBarLoading

Animated bar moving back and forth:

with ProgressBarLoading(
    barline='-', animation='â–ˆ', length=30,
    message="Loading", end_message="Complete!", delay=0.05
):
    do_work()

3. GlitchLoading

Random-character glitch effect:

with GlitchLoading(
    text="Decrypting...",
    end_message="Access Granted!",
    delay=0.1
):
    do_work()

Color Options

All effects support an optional color parameter (via termcolor):

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

Ensure your terminal supports ANSI colors for termcolor outputs.

Dependencies

• Python 3.9+
• termcolor

Install dependencies:

pip install -r requirements.txt

📄 License

MIT License — see LICENSE.

---

Enjoy Textfx v2.2! 🎉