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 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
  2. Scramble Effect
  3. Wave Text
  4. Untyping Effect
  5. Unscramble Effect
  6. Unwave Text
  7. Loading Animations
  8. Color Support via termcolor

Usage

Import the desired effects and loaders:

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

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 ProgressBarLoading(message="Compiling Code", barline=".", animation="âš™", length=40, message_color="cyan", animation_color="yellow", barline_color="white", delay=0.07):
    time.sleep(5)

For detailed examples, see Documention.

Color Options

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

black red green yellow blue magenta cyan white

light_grey dark_grey light_red light_green light_yellow light_blue light_magenta light_cyan

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 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.4.2.tar.gz (7.6 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.4.2-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for textfx-2.4.2.tar.gz
Algorithm Hash digest
SHA256 a5486e4e3ef093032ee31daf003f2aaf132fd5efc6959c372d1da6189e48cb74
MD5 ebf01f2520f0fad0a133cb616be3f5dc
BLAKE2b-256 c583ef85a8241101b7ff87d77b6fd65999eea33bd87c49103d90ae9a8a91295d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: textfx-2.4.2-py3-none-any.whl
  • Upload date:
  • Size: 7.1 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.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8fb4dd7998485a5cd33eb2a5ffe340ec9d72155f672f18a28df8a304811e304b
MD5 76712ed0fb569f167573806fdfc8cc21
BLAKE2b-256 211528a520bcee15c8d98735a10022dadbdb5ffde1a66bfbe3c1731a1a2660a8

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