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 False.
  • verbose_errors (bool, optional): Whether to print the error traceback. Defaults to False.
  • frames (str, optional): The frames of the animation. Defaults to '|/-\\'.

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!

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.0.1.tar.gz (3.3 kB view hashes)

Uploaded Source

Built Distribution

pynimbar-1.0.1-py3-none-any.whl (3.6 kB view hashes)

Uploaded Python 3

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