Skip to main content

Make your Python scripts more user friendly with loading animations

Project description

pynimbar

pynimbar is a Python package that provides a simple and customizable loading animation for console-based applications. The package allows you to create loading animations with custom text, as well as adjust the animation speed and style.

Installation

You can install pynimbar using pip:

pip install pynimbar

Usage

pynimbar provides a context manager that allows you to use the loading animation as a context manager. This can be useful if you want to ensure that the loading animation is automatically stopped when an error occurs or when your code finishes executing. For example:

from pynimbar import loading_animation
from time import sleep

with loading_animation('Processing data...'):
    sleep(5)

Customization

You can customize the appearance and behavior of the loading animation using the following parameters:

  • text (str): The text to display during the animation.
  • success_msg (str, optional): The text to display when the animation is done. Defaults to 'ok'.
  • animation_frequency (float, optional): The frequency of the animation. Defaults to 0.1.
  • break_on_error (bool, optional): Whether to break on error. Defaults to True.
  • verbose_errors (bool, optional): Whether to print the error traceback. Defaults to False.
  • frames (str, optional): The frames of the animation. Defaults to '|/-\\'.
  • time_it (bool, optional): Whether to time the execution of the code block. Defaults to False.
  • time_it_live (bool, optional): Whether to print the live execution time of the code block. Defaults to False.

Contributing

If you have any suggestions or improvements for pynimbar, feel free to submit a pull request or open an issue on the GitHub repository. We appreciate any feedback or contributions!

Example

Example functionality

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

pynimbar-1.1.1.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

pynimbar-1.1.1-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file pynimbar-1.1.1.tar.gz.

File metadata

  • Download URL: pynimbar-1.1.1.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for pynimbar-1.1.1.tar.gz
Algorithm Hash digest
SHA256 0d83d8b45d09b720d89fb4ce2b47db18c0d3f9cb5f435418915faf6c46ae0a7e
MD5 d0c2e27017447e6dfe9fcb4653d463b7
BLAKE2b-256 8b4039d35f2bd212b7062cb9a7d11a8dcf6f30d67e7c969ca046f03790c3244d

See more details on using hashes here.

Provenance

File details

Details for the file pynimbar-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: pynimbar-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 4.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for pynimbar-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6ae0bd12cae222370a927a702e9585991e57b8347b3a5f1b06698f6982cc4b8c
MD5 f95effd850e9655c74d1c769bac954c0
BLAKE2b-256 8c3b229fd9e29c70824506d7c6b0038315d66a5a847c5daf415feecf0d5f3c0c

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page