jabbar
======
|build| |coverage| |pypi| |black|
Just Another Beautiful progress BAR (some might replace Beautiful by Boring).
jabbar is a python package implementing a simple progress bar. The output
looks like:
.. code-block:: sh
75% |█████████████████ | 750/1000
It is lightweight, easy to use and customizable.
As a special feature, it gracefully deals with seeing more items than expected, e.g. 1100/1000.
Also, it supports unicorns.
|shell|
For very serious work, you may want to try e.g. the slightly more professional `tqdm <https://github.com/tqdm/tqdm>`_ package.
Install
-------
jabbar can be installed from `PyPI <https://pypi.org/project/jabbar>`_ via your favorite shell:
.. code-block:: sh
$ pip install jabbar
or from the latest code on `GitHub <https://github.com/yannikschaelte/jabbar>`_ with:
.. code-block:: sh
$ pip install git+https://github.com/yannikschaelte/jabbar.git
Get started
-----------
jabbar is quite flexible and can operate in different modes.
jabbar can simply wrap around any iterable to make loops show a little progress
bar:
.. code-block:: python
from jabbar import jabbar
for _ in jabbar(range(1000)):
pass
The updating scheme can also be individually specified:
.. code-block:: python
from jabbar import jabbar
with jabbar(total=1000, width=30) as bar:
for _ in range(50):
bar.inc(20)
When usage of a context manager is undesirable, use ``jabbar.finish()`` to clean up the output.
Further examples can be found in the `example/howto.ipynb <https://github.com/yannikschaelte/jabbar/blob/master/example/howto.ipynb>`_ notebook.
License
-------
jabbar is available under an MIT license.
.. |build| image:: https://github.com/yannikschaelte/jabbar/workflows/CI/badge.svg
:target: https://github.com/yannikschaelte/jabbar/actions
:alt: Build status
.. |coverage| image:: https://codecov.io/gh/yannikschaelte/jabbar/branch/master/graph/badge.svg
:target: https://codecov.io/gh/yannikschaelte/jabbar
.. |pypi| image:: https://img.shields.io/pypi/v/jabbar.svg
:target: https://pypi.org/project/jabbar/
:alt: Current version on PyPI
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code style: Black
.. |shell| image:: https://raw.githubusercontent.com/yannikschaelte/jabbar/master/example/shell.gif
:alt: Animation of jabbar in use
Raw data
{
"_id": null,
"home_page": "https://github.com/yannikschaelte/jabbar",
"name": "jabbar",
"maintainer": "Yannik Schaelte",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "yannik.schaelte@gmail.com",
"keywords": "Progress bar,Status bar,Jabberwocky",
"author": "Yannik Schaelte",
"author_email": "yannik.schaelte@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/eb/bb/7b70526081d428e17d1fe2ac2c41e8ec068dcee12af6a87ea5ef581abf71/jabbar-0.0.16.tar.gz",
"platform": null,
"description": "jabbar\n======\n\n|build| |coverage| |pypi| |black|\n\nJust Another Beautiful progress BAR (some might replace Beautiful by Boring).\n\njabbar is a python package implementing a simple progress bar. The output\nlooks like:\n\n.. code-block:: sh\n\n 75% |\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588 | 750/1000\n\nIt is lightweight, easy to use and customizable.\nAs a special feature, it gracefully deals with seeing more items than expected, e.g. 1100/1000.\nAlso, it supports unicorns.\n\n|shell|\n\nFor very serious work, you may want to try e.g. the slightly more professional `tqdm <https://github.com/tqdm/tqdm>`_ package.\n\n\nInstall\n-------\n\njabbar can be installed from `PyPI <https://pypi.org/project/jabbar>`_ via your favorite shell:\n\n.. code-block:: sh\n\n $ pip install jabbar\n\nor from the latest code on `GitHub <https://github.com/yannikschaelte/jabbar>`_ with:\n\n.. code-block:: sh\n\n $ pip install git+https://github.com/yannikschaelte/jabbar.git\n\n\nGet started\n-----------\n\njabbar is quite flexible and can operate in different modes.\n\njabbar can simply wrap around any iterable to make loops show a little progress\nbar:\n\n.. code-block:: python\n\n from jabbar import jabbar\n for _ in jabbar(range(1000)):\n pass\n\nThe updating scheme can also be individually specified:\n\n.. code-block:: python\n\n from jabbar import jabbar\n with jabbar(total=1000, width=30) as bar:\n for _ in range(50):\n bar.inc(20)\n\nWhen usage of a context manager is undesirable, use ``jabbar.finish()`` to clean up the output.\n\nFurther examples can be found in the `example/howto.ipynb <https://github.com/yannikschaelte/jabbar/blob/master/example/howto.ipynb>`_ notebook.\n\n\nLicense\n-------\n\njabbar is available under an MIT license.\n\n\n.. |build| image:: https://github.com/yannikschaelte/jabbar/workflows/CI/badge.svg\n :target: https://github.com/yannikschaelte/jabbar/actions\n :alt: Build status\n\n\n.. |coverage| image:: https://codecov.io/gh/yannikschaelte/jabbar/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/yannikschaelte/jabbar\n\n\n.. |pypi| image:: https://img.shields.io/pypi/v/jabbar.svg\n :target: https://pypi.org/project/jabbar/\n :alt: Current version on PyPI\n\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code style: Black\n\n\n.. |shell| image:: https://raw.githubusercontent.com/yannikschaelte/jabbar/master/example/shell.gif\n :alt: Animation of jabbar in use\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Just Another Beautiful progress BAR",
"version": "0.0.16",
"project_urls": {
"Bug Tracker": "https://github.com/yannikschaelte/jabbar/issues",
"Documentation": "https://github.com/yannikschaelte/jabbar",
"Download": "https://github.com/yannikschaelte/jabbar/releases",
"Homepage": "https://github.com/yannikschaelte/jabbar",
"Source Code": "https://github.com/yannikschaelte/jabbar"
},
"split_keywords": [
"progress bar",
"status bar",
"jabberwocky"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8437f073570895069e105fb9d26c978721ba26b80d211784e75ea7a4799b8878",
"md5": "9ddb9647283c5e19a725865f2289d022",
"sha256": "50d4392202b32a3781a8626e6895b893acf54c5e1ac1c2340b70f3d71f707d04"
},
"downloads": -1,
"filename": "jabbar-0.0.16-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9ddb9647283c5e19a725865f2289d022",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6488,
"upload_time": "2023-09-07T07:20:11",
"upload_time_iso_8601": "2023-09-07T07:20:11.038945Z",
"url": "https://files.pythonhosted.org/packages/84/37/f073570895069e105fb9d26c978721ba26b80d211784e75ea7a4799b8878/jabbar-0.0.16-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ebbb7b70526081d428e17d1fe2ac2c41e8ec068dcee12af6a87ea5ef581abf71",
"md5": "644de47fc34aecdfc92af7e52c12788c",
"sha256": "522f29ca04e44a25fbc3ae0419f7d7bf96af1b9d131bbd8b58899224fc5eb0f5"
},
"downloads": -1,
"filename": "jabbar-0.0.16.tar.gz",
"has_sig": false,
"md5_digest": "644de47fc34aecdfc92af7e52c12788c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 5869,
"upload_time": "2023-09-07T07:20:12",
"upload_time_iso_8601": "2023-09-07T07:20:12.932911Z",
"url": "https://files.pythonhosted.org/packages/eb/bb/7b70526081d428e17d1fe2ac2c41e8ec068dcee12af6a87ea5ef581abf71/jabbar-0.0.16.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-07 07:20:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yannikschaelte",
"github_project": "jabbar",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "jabbar"
}
JSON
