| Name | ipypb JSON |
| Version |
0.5.2
JSON |
| download |
| home_page | |
| Summary | Interactive ProgressBar natively built with IPython |
| upload_time | 2019-02-07 08:17:05 |
| maintainer | |
| docs_url | None |
| author | Evgeny Frolov |
| requires_python | |
| license | |
| keywords |
progressbar
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Interactive ProgressBar
Python progress bar that uses native ipython functionality. Widget-free. Works even in JupyterLab.
The reason for creating this package is that other progress bars use custom bar objects and/or widget tools, ignoring the builtin `IPython` functionality. This makes them unusable in "clean" environments like JupyterLab. In contrast, `ipypb` can run even in very restricted environments.
Another useful feature of `ipypb` is that the progress bar information is available even after closing a notebook and killing its ipython kernel. Once you launch this notebook again, you'll see the same progress bar information as before closing instead of widjet-related erorrs like `Failed to display Jupyter Widget of type HBox`, as shown below:
Also have a look at this [NBViewer example](https://nbviewer.jupyter.org/github/evfro/ipypb/blob/master/examples/Usage%20examples.ipynb).
# Notes
Currently at beta stage.
Simple usage example:
```python
from time import sleep
from ipypb import track
for i in track(range(10)):
sleep(0.1)
```
A few other conveniences are available. For example, you can use `ipypb` as a python's range-like function:
```python
from ipypb import irange
for i in irange(1, 10, 2): # same as range(1, 10, 2) but with progressbar
# <do stuff>
...
```
It may also be helpful to use the factory method `ipb`, which handles different usage scenarios and returns either `track` or `irange` instance depending on input arguments. Another usage example is when you already have a bunch of code with [`tqdm`](https://github.com/tqdm/tqdm) and want to
replace it with `ipypb`:
```python
from ipypb import ipb
tqdm_notebook = ipb
# or if you run it in interactive shell
tqdm = ipb
```
It will automatically process keyword arguments to ensure compatibility with `tqdm`'s API. Note, that `ipb` offers a common interface for both notebook and terminal environments.
## Asynchronous flow
It's also possible to use `ipypb` for tracking tasks that are executed asyncrhonously or in parallel. The major use case is when the order of executed tasks from a task pool doesn't correspond to the desired order for displaying a progress. In this case, you can instruct `ipypb` to preserve the desired order by submitting a description of the progress hierarchy. Below is an example for simple heirarchy consisting of three levels: `i <-- j <-- k`. Progress on each parent level depends on full exectunion of its sublevels. Note how levels `k:1` and `k:2` get moved to the group `j:0` they belong to, even though initially they appear in the end, below the `j:1` group:
**Note**: this feature is currently in provisional state, which means that its API main change in future releases. In order to test it, do
```python
from ipypb import chain
```
# Install
`pip install --upgrade ipypb`
# Requirements
Python 3.6+ and IPython v.5.6+ excluding v.6.1 and v.6.2
# Limitations
- The feature to erase progressbar when loop is over is not yet supported.
Raw data
{
"_id": null,
"home_page": "",
"name": "ipypb",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "progressbar",
"author": "Evgeny Frolov",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/d4/3d/27a4c48c11e06b7f0ffe9898156f29184dc68698e70bb556daa9638474b8/ipypb-0.5.2.tar.gz",
"platform": "any",
"description": "# Interactive ProgressBar\nPython progress bar that uses native ipython functionality. Widget-free. Works even in JupyterLab.\n\nThe reason for creating this package is that other progress bars use custom bar objects and/or widget tools, ignoring the builtin `IPython` functionality. This makes them unusable in \"clean\" environments like JupyterLab. In contrast, `ipypb` can run even in very restricted environments.\n\nAnother useful feature of `ipypb` is that the progress bar information is available even after closing a notebook and killing its ipython kernel. Once you launch this notebook again, you'll see the same progress bar information as before closing instead of widjet-related erorrs like `Failed to display Jupyter Widget of type HBox`, as shown below:\n\n\n\nAlso have a look at this [NBViewer example](https://nbviewer.jupyter.org/github/evfro/ipypb/blob/master/examples/Usage%20examples.ipynb).\n\n# Notes\nCurrently at beta stage.\n\nSimple usage example:\n```python\nfrom time import sleep\nfrom ipypb import track\n\nfor i in track(range(10)):\n sleep(0.1)\n```\nA few other conveniences are available. For example, you can use `ipypb` as a python's range-like function:\n```python\nfrom ipypb import irange\n\nfor i in irange(1, 10, 2): # same as range(1, 10, 2) but with progressbar\n # <do stuff>\n ...\n```\nIt may also be helpful to use the factory method `ipb`, which handles different usage scenarios and returns either `track` or `irange` instance depending on input arguments. Another usage example is when you already have a bunch of code with [`tqdm`](https://github.com/tqdm/tqdm) and want to \nreplace it with `ipypb`:\n```python\nfrom ipypb import ipb\n\ntqdm_notebook = ipb\n# or if you run it in interactive shell\ntqdm = ipb\n```\nIt will automatically process keyword arguments to ensure compatibility with `tqdm`'s API. Note, that `ipb` offers a common interface for both notebook and terminal environments.\n\n## Asynchronous flow\nIt's also possible to use `ipypb` for tracking tasks that are executed asyncrhonously or in parallel. The major use case is when the order of executed tasks from a task pool doesn't correspond to the desired order for displaying a progress. In this case, you can instruct `ipypb` to preserve the desired order by submitting a description of the progress hierarchy. Below is an example for simple heirarchy consisting of three levels: `i <-- j <-- k`. Progress on each parent level depends on full exectunion of its sublevels. Note how levels `k:1` and `k:2` get moved to the group `j:0` they belong to, even though initially they appear in the end, below the `j:1` group:\n\n\n\n**Note**: this feature is currently in provisional state, which means that its API main change in future releases. In order to test it, do \n```python\nfrom ipypb import chain\n```\n\n# Install\n`pip install --upgrade ipypb`\n\n# Requirements\nPython 3.6+ and IPython v.5.6+ excluding v.6.1 and v.6.2\n\n# Limitations\n- The feature to erase progressbar when loop is over is not yet supported.\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Interactive ProgressBar natively built with IPython",
"version": "0.5.2",
"project_urls": null,
"split_keywords": [
"progressbar"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "03340690f80e96e5fe8dbc8b29ed5255ad066555e13807989084eac6d4ca4fca",
"md5": "d41b7402d275036bf731b48afa643fa6",
"sha256": "625a201d4c912ac498fa297f19291959f3dadbd37247d873d0291bf197e0f82d"
},
"downloads": -1,
"filename": "ipypb-0.5.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d41b7402d275036bf731b48afa643fa6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8589,
"upload_time": "2019-02-07T08:17:02",
"upload_time_iso_8601": "2019-02-07T08:17:02.986359Z",
"url": "https://files.pythonhosted.org/packages/03/34/0690f80e96e5fe8dbc8b29ed5255ad066555e13807989084eac6d4ca4fca/ipypb-0.5.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d43d27a4c48c11e06b7f0ffe9898156f29184dc68698e70bb556daa9638474b8",
"md5": "ec9d32da46c211f0a34fd74cc7df4ddc",
"sha256": "ce87f3845502ca1e47a69aa79a03fbca13edd8e23fbcdbe608c4c6b243bed2b3"
},
"downloads": -1,
"filename": "ipypb-0.5.2.tar.gz",
"has_sig": false,
"md5_digest": "ec9d32da46c211f0a34fd74cc7df4ddc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7480,
"upload_time": "2019-02-07T08:17:05",
"upload_time_iso_8601": "2019-02-07T08:17:05.464314Z",
"url": "https://files.pythonhosted.org/packages/d4/3d/27a4c48c11e06b7f0ffe9898156f29184dc68698e70bb556daa9638474b8/ipypb-0.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2019-02-07 08:17:05",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ipypb"
}
