ManrajGrover / halo
- вторник, 3 октября 2017 г. в 03:13:51
https://github.com/ManrajGrover/halo
Beautiful terminal spinners in Python
halo
Beautiful terminal spinners in Python
Install
$ pip install haloUsage
from halo import Halo
spinner = Halo({'text': 'Loading', 'spinner': 'dots'})
spinner.start()
# Run time consuming work here
# You can also change properties for spinner as and when you want
spinner.stop()API
Halo([options|text])
If a string is given, it will be treated as text for spinner.
options
A dictionary defining various available settings.
text
Type: str
Text shown along with spinner.
spinner
Type: str|dict
If string, it should be one of the spinners listed in the given json file. If a dict is passed, it should define interval and frames. Something like:
{
'interval': 100,
'frames': ['-', '+', '*', '+', '-']
}Defaults to dots spinner. For Windows users, it defaults to line spinner.
color
Type: str
Values: grey, red, green, yellow, blue, magenta, cyan, white
Color of the spinner. Defaults to cyan.
interval
Type: float
Interval between each frame. Defaults to spinner interval (recommended).
stream
Type: file
Stream to write the output. Defaults to sys.stdout.
enabled
Type: bool
Enable or disable the spinner. Defaults to True.
Methods
Following are the methods available:
spinner.start([text])
Starts the spinner. If text is passed, it is set as spinner text. Returns the instance.
spinner.stop()
Stops and clears the spinner. Returns the instance.
spinner.clear()
Clears the spinner. Returns the instance.
spinner.render()
Manually renders a new frame. Returns the instance.
spinner.frame()
Returns next frame to be rendered.
spinner.succeed([text])
text: Type: str
Stops the spinner and changes symbol to ✔. If text is provided, it is persisted else current text is persisted. Returns the instance.
spinner.fail([text])
text: Type: str
Stops the spinner and changes symbol to ✖. If text is provided, it is persisted else current text is persisted. Returns the instance.
spinner.warn([text])
text: Type: str
Stops the spinner and changes symbol to ⚠. If text is provided, it is persisted else current text is persisted. Returns the instance.
spinner.info([text])
text: Type: str
Stops the spinner and changes symbol to ℹ. If text is provided, it is persisted else current text is persisted. Returns the instance.
spinner.stop_and_persist([options])
options: Type: dict
Stops the spinner and changes symbol and text. Returns the instance.
options
symbol
Type: str
Symbol to replace the spinner with. Defaults to ' '.
text
Type: str
Text to be persisted. Defaults to instance text.
spinner.text
Change the text of spinner.
spinner.color
Change the color of spinner
spinner.spinner
Change the spinner itself.
To Do
Like it?
Related
License
MIT © Manraj Singh