Skip to main content

Python-asynchronous progressbar widgets for use in Jupyter/IPython in conjunction with ipywidgets

Project description

IPyProgressBar

saythanks

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. (Yes we could parallelize it, but it seems a little of overkill).

We will create an HTML object with the progressbar and then let python trigger a small javascript snippet that during a specific interval time regularly updates the progressbar, while python goes on working on other tasks (like loading a dataset). That way, the task of rendering and updating the progressbar is fully delegated to the browser.

Usage

# Create the progress bar object (not the widget)
my_progressbar = AsyncProgressBar(time=2, description='Loading dataset:')

# Return the widget for display
display( my_progressbar.get_widget() )

# ...

# Trigger the progressbar
my_progressbar.run()

The object also has a hide() method, for a typical use case in which we just want a temporal progressbar:

my_progressbar.run()
function_that_takes_long()
my_progressbar.hide()

Contact

Created by: WillahScott

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

ipyprogressbar-0.1.0.tar.gz (3.5 kB view details)

Uploaded Source

Built Distribution

ipyprogressbar-0.1.0-py3-none-any.whl (3.8 kB view details)

Uploaded Python 3

File details

Details for the file ipyprogressbar-0.1.0.tar.gz.

File metadata

File hashes

Hashes for ipyprogressbar-0.1.0.tar.gz
Algorithm Hash digest
SHA256 711b681c6083be0dc51c8a52822ba71b27386d762f6e5392dfde03094b9aed52
MD5 b95dbe4572027d0372d3e54002a178e0
BLAKE2b-256 630e8020305db4a787335ecacb21239f4ddd8894e980f3b95b8aa998a81036de

See more details on using hashes here.

File details

Details for the file ipyprogressbar-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ipyprogressbar-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3d516bf16efe8869e0c8feeec78c42c4fec58a090cf6e33493e2d636774696a0
MD5 5d328cbdc229deba26828d5d154bef41
BLAKE2b-256 92b5bf3fe20eea69923d22c33d030f85d88e0a7c96ce2832919fd75472c99580

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page