IPyProgressBar
A small package that provides an python-asynchronous progressbar widgets for use in Jupyter/IPython in conjunction with ipywidgets.
Why
Many times, when building a small dashboard on IPython there are functions that take some time to be executed but cannot be split into chunks, in the middle of which we could update a progress bar.
Since we want to give the user feedback that we are actually doing something and now he has to wait for a little, we can simply display the prototypical Loading....
However for some (most?) functions we may actually have a rough estimate of the time of wait and can make the wait a little more visual with a progressbar!
"Python-Asynchronous"
The progressbar needs to be updated (filled) while python is working on other things. Therefore, we can use a python thread to update the value of the progressbar. That way, our main python process can take care of other code meanwhile.
Usage
# Create the progress bar object (not the widget)
my_progressbar = AsyncProgressBar(time=2, description='Loading dataset:')
# Return the widget for display
my_progressbar.display()
# ...
# Trigger the progressbar
my_progressbar.run()
The object also has a close() method (and its inverse reopen()), for hiding the progressbar whenever we want:
my_progressbar.run()
function_that_takes_long()
my_progressbar.close(on_finish=True) # or set close_on_finish=True on creating the progressbar object
However,for a typical use case in which we just want a temporal progressbar, we can specify the close_on_finish on creation:
# Create the progress bar object (not the widget)
my_progressbar = AsyncProgressBar(time=2, description='Loading dataset:', close_on_finish=True)
# ...
# Trigger the progressbar
my_progressbar.run() # when done the progress bar will hide
Contact
Created by: WillahScott
Metadata
Release files for ipyprogressbar 1.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ipyprogressbar-1.0.2.tar.gz | 3.5 kB | Without provenance | Details for ipyprogressbar-1.0.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ipyprogressbar-1.0.2-py3-none-any.whl | Python 3 | none | any | Details for ipyprogressbar-1.0.2-py3-none-any.whl |
Total release size: 7.4 kB
Release files / ipyprogressbar-1.0.2.tar.gz
| Download URL | ipyprogressbar-1.0.2.tar.gz |
|---|---|
| Size | 3.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a0b9a8b1deaccb6c13a91b64d7728cbc5cb7e136c6391e8b34a11ab73e052bbc
|
|
BLAKE2b-256 checksum How to use checksums |
10b21f6e0630328bef645ead9574ef74fdda75b9d87d792b1c37136b25ded32e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / ipyprogressbar-1.0.2-py3-none-any.whl
| Download URL | ipyprogressbar-1.0.2-py3-none-any.whl |
|---|---|
| Size | 3.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fe5f47547f897043b237d56ea8b493cb9fa61327d1dc45437368e0ca33fa7019
|
|
BLAKE2b-256 checksum How to use checksums |
5346962b97a06158bc6fa3316bfb26e46ee1f6c299adbf28a55cdd39c6fcc3d0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for ipyprogressbar 1.0.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.