Enlighten Progress Bar
Project description
Overview
Enlighten Progress Bar is a console progress bar library for Python.
The main advantage of Enlighten is it allows writing to stdout and stderr without any redirection or additional code. Just print or log as you normally would.
Enlighten also includes experimental support for Jupyter Notebooks.
The code for this animation can be found in demo.py in examples.
Documentation
Installation
PIP
$ pip install enlightenRPM
Fedora and EL8 (RHEL/CentOS)
(EPEL repositories must be configured for EL8)
$ dnf install python3-enlightenEL7 (RHEL/CentOS)
(EPEL repositories must be configured)
$ yum install python2-enlighten
$ yum install python36-enlightenPKG
Arch Linux
$ pacman -S python-enlightenDEB
Debian and Ubuntu
$ apt-get install python3-enlightenConda
$ conda install -c conda-forge enlightenExamples
Basic
For a basic status bar, invoke the Counter class directly.
import time
import enlighten
pbar = enlighten.Counter(total=100, desc='Basic', unit='ticks')
for num in range(100):
time.sleep(0.1) # Simulate work
pbar.update()Advanced
To maintain multiple progress bars simultaneously or write to the console, a manager is required.
Advanced output will only work when the output stream, sys.__stdout__ by default, is attached to a TTY. get_manager can be used to get a manager instance. It will return a disabled Manager instance if the stream is not attached to a TTY and an enabled instance if it is.
import time
import enlighten
manager = enlighten.get_manager()
ticks = manager.counter(total=100, desc='Ticks', unit='ticks')
tocks = manager.counter(total=20, desc='Tocks', unit='tocks')
for num in range(100):
time.sleep(0.1) # Simulate work
print(num)
ticks.update()
if not num % 5:
tocks.update()
manager.stop()Counters
The Counter class has two output formats, progress bar and counter.
The progress bar format is used when a total is not None and the count is less than the total. If neither of these conditions are met, the counter format is used:
import time
import enlighten
counter = enlighten.Counter(desc='Basic', unit='ticks')
for num in range(100):
time.sleep(0.1) # Simulate work
counter.update()Additional Examples
basic - Basic progress bar
context manager - Managers and counters as context managers
floats - Support totals and counts that are floats
multicolored - Multicolored progress bars
multiple with logging - Nested progress bars and logging
FTP downloader - Show progress downloading files from FTP
Customization
Enlighten is highly configurable. For information on modifying the output, see the Series and Format sections of the Counter documentation.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file enlighten-1.11.0.tar.gz.
File metadata
- Download URL: enlighten-1.11.0.tar.gz
- Upload date:
- Size: 60.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 CPython/3.10.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3dd8aa875e4f90795223cdf858517f38e36fcf3a5710525e15df4ed93def6b3b |
|
| MD5 | 053f498febd6c29e61e2eb481de1acd7 |
|
| BLAKE2b-256 | 314ed420bb68622b5b17626689dfad3aeac51f997dba8c0507f2f803430706d0 |
File details
Details for the file enlighten-1.11.0-py2.py3-none-any.whl.
File metadata
- Download URL: enlighten-1.11.0-py2.py3-none-any.whl
- Upload date:
- Size: 53.4 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 CPython/3.10.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c5fb65d9281c9ddcdfad4e2dc731098c7379c72fe20d60d92c578cecec967ff0 |
|
| MD5 | 2073b01cd1c4d4520c8c65eb2853bc0c |
|
| BLAKE2b-256 | 77f94ae7eb5f1c0d405689358f32e90d8eb2c0a054970a035cf9ecebd64dc391 |
