Skip to main content

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

Project description

Textfx v2.2.1

PyPI Downloads Python License Repo Size

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

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

Install dependencies:

pip install -r requirements.txt

Contributing

Pull requests are welcome! For more examples and details, refer to docs/examples.md.

License

MIT License — see LICENSE.


Enjoy 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.2.1.tar.gz (6.1 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.2.1-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: textfx-2.2.1.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.6

File hashes

Hashes for textfx-2.2.1.tar.gz
Algorithm Hash digest
SHA256 d2d6d29ee9a857e74ea999fe32e8afd81745185c8f8a680c7ad32dc19407c36c
MD5 003b4a662d56c3cef99e6eead654df83
BLAKE2b-256 b7cd1d83dd8b6b4d68640caa12e7778eca934743abee3c048a41ac9c28d0588e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: textfx-2.2.1-py3-none-any.whl
  • Upload date:
  • Size: 6.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.6

File hashes

Hashes for textfx-2.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2a93c1462765877133f2901f571891993f9e70977081a006a427211326571d3c
MD5 ef6c4c8fb5d010cb1db186bcbc0438e1
BLAKE2b-256 6b1963a5873fb0aee89a093f1ae92c379a715e57ada9e5644a91aa176bf65da9

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