Defaults to instance text.Ĭhange the text of spinner. Stops the spinner and changes symbol and text. If text is provided, it is persisted else current text is persisted. Stops the spinner and changes symbol to ℹ. Stops the spinner and changes symbol to ⚠. Stops the spinner and changes symbol to ✖. Stops the spinner and changes symbol to ✔. If text is passed, it is set as spinner text. Methodsįollowing are the methods available: spinner.start() Defaults to spinner interval (recommended). Defaults to left colorĬolor of the spinner. Which side of the text the spinner should be displayed. If no animation is defined, the text will be ellipsed. animationĪnimation to apply to the text if it's too large and doesn't fit in the terminal. For Windows users, it defaults to line spinner. Something like: ĭefaults to dots spinner. If a dict is passed, it should define interval and frames.

If string, it should be one of the spinners listed in the given json file. Type: str Values: grey, red, green, yellow, blue, magenta, cyan, whiteĬolor of the spinner text. stop ()Īlternatively, you can use halo with Python's with statement: from halo import Halo with Halo ( text = 'Loading', spinner = 'dots' ): # Run time consuming work hereįinally, you can use halo as a decorator: from halo import Halo ( text = 'Loading', spinner = 'dots' ) def long_running_function (): # Run time consuming work here pass long_running_function () API Halo() text start () # Run time consuming work here # You can also change properties for spinner as and when you want spinner. Usage from halo import Halo spinner = Halo ( text = 'Loading', spinner = 'dots' ) spinner. Beautiful spinners for terminal, IPython and Jupyter

Halo 1 library