Skip to main content

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

Project description

Textfx

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", delay=0.05
):
    do_work()

3. GlitchLoading

Random-character glitch effect:

with GlitchLoading(
    text="Decrypting...",
    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.3.1.tar.gz (6.0 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.3.1-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for textfx-2.3.1.tar.gz
Algorithm Hash digest
SHA256 d4094d974c4aaae9f3b69ac330d1d7884ba84ab824309700f625d36147df2985
MD5 3f4c95caf983e04d34e0361afa7c8d23
BLAKE2b-256 d81fe5caf60a86ff1bb0e66e7a17c0183d8fb6214e725bfe36d17a4c19223e9f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: textfx-2.3.1-py3-none-any.whl
  • Upload date:
  • Size: 6.7 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.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ff0b9488dfd97ab967eebcb11942a038ab949c4f333208b1c492454f611345ac
MD5 c365be122cfd3623c6a21a7121ae0649
BLAKE2b-256 63c46b0cf244b2fa9b8b62aca4d7daa803a907f6710ef4b155d2bb07fd81b972

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