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 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.3.2.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.2-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: textfx-2.3.2.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.2.tar.gz
Algorithm Hash digest
SHA256 5903dde80572ec210587ae3d39f9e12d92bea5c0c8ff6d0ba3867d01eee3b643
MD5 7a79ce5569fc6d1838bcb99cda7d369c
BLAKE2b-256 1081c711ec1af4947147a3c5026d9ae9025e1a85d205923cd96bba38ee53898d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: textfx-2.3.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 de09b7249a426db83a82261f2acf0026fe9fb77d1fe6668129a416edeaf1faf2
MD5 7e79a8736f71aeff0140a9f0503fb7d6
BLAKE2b-256 f2e911b0f085123acb0677e036b1f08823449691a5e4fdc78a4576c8800ccab1

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