=============
Parallel TQDM
=============
.. image:: https://img.shields.io/pypi/v/pqdm.svg
:target: https://pypi.python.org/pypi/pqdm
.. image:: https://readthedocs.org/projects/pqdm/badge/?version=latest
:target: https://pqdm.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://pyup.io/repos/github/niedakh/pqdm/shield.svg
:target: https://pyup.io/repos/github/niedakh/pqdm/
:alt: Updates
PQDM is a TQDM and concurrent futures wrapper to allow enjoyable paralellization of
iterating through an Iterable with a progress bar.
* Free software: MIT license
* Documentation: https://pqdm.readthedocs.io.
Install & Use
-------------
To install ::
pip install pqdm
and use ::
from pqdm.processes import pqdm
# If you want threads instead:
# from pqdm.threads import pqdm
args = [1, 2, 3, 4, 5]
# args = range(1,6) would also work
def square(a):
return a*a
result = pqdm(args, square, n_jobs=2)
For more examples variants check the `Usage <https://pqdm.readthedocs.io/en/latest/usage.html>`_ section of the docs.
Features
--------
* parellize your tqdm runs using processes or threads thanks to concurrent.futures,
* just import ``pqdm`` from ``pqdm.threads`` or ``pqdm.processes`` to start,
* automatic usage of ``tqdm.notebook`` when iPython/Jupyter notebook environment detected, custom tqdm class accepted
* automatic parsing of ``pqdm`` kwargs and separating between ``concurrent.Executor`` args and ``tqdm`` args,
* support for any iterable and passing items as kwargs, args or directly to function which is being applied
* support bounded exectutors via https://github.com/mowshon/bounded_pool_executor
Credits
-------
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
=======
History
=======
0.2.0 (2022-02-14)
------------------
* Adds exception handling
* Allows using custom tqdm_class (like tqdm_discord)
* Minor fixes
0.1.0 (2020-03-07)
------------------
* Some updates in progress reporting and documentation.
0.0.1 (2020-03-05)
------------------
* First release on PyPI.
Raw data
{
"_id": null,
"home_page": "https://github.com/niedakh/pqdm",
"name": "pqdm",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "pqdm",
"author": "Piotr Szyma\u0144ski",
"author_email": "niedakh@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/fb/dd/1b2ae6551a32bf8ae26b90c6e191a889bee5050bf23c88021761fbca03d1/pqdm-0.2.0.tar.gz",
"platform": "",
"description": "=============\nParallel TQDM\n=============\n\n\n.. image:: https://img.shields.io/pypi/v/pqdm.svg\n :target: https://pypi.python.org/pypi/pqdm\n\n.. image:: https://readthedocs.org/projects/pqdm/badge/?version=latest\n :target: https://pqdm.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n\n.. image:: https://pyup.io/repos/github/niedakh/pqdm/shield.svg\n :target: https://pyup.io/repos/github/niedakh/pqdm/\n :alt: Updates\n\n\n\nPQDM is a TQDM and concurrent futures wrapper to allow enjoyable paralellization of\niterating through an Iterable with a progress bar.\n\n\n* Free software: MIT license\n* Documentation: https://pqdm.readthedocs.io.\n\n\nInstall & Use\n-------------\n\nTo install ::\n\n pip install pqdm\n\n\nand use ::\n\n from pqdm.processes import pqdm\n # If you want threads instead:\n # from pqdm.threads import pqdm\n\n args = [1, 2, 3, 4, 5]\n # args = range(1,6) would also work\n\n def square(a):\n return a*a\n\n result = pqdm(args, square, n_jobs=2)\n\nFor more examples variants check the `Usage <https://pqdm.readthedocs.io/en/latest/usage.html>`_ section of the docs.\n\nFeatures\n--------\n\n* parellize your tqdm runs using processes or threads thanks to concurrent.futures,\n* just import ``pqdm`` from ``pqdm.threads`` or ``pqdm.processes`` to start,\n* automatic usage of ``tqdm.notebook`` when iPython/Jupyter notebook environment detected, custom tqdm class accepted\n* automatic parsing of ``pqdm`` kwargs and separating between ``concurrent.Executor`` args and ``tqdm`` args,\n* support for any iterable and passing items as kwargs, args or directly to function which is being applied\n* support bounded exectutors via https://github.com/mowshon/bounded_pool_executor\n\nCredits\n-------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n\n\n=======\nHistory\n=======\n\n0.2.0 (2022-02-14)\n------------------\n\n* Adds exception handling\n* Allows using custom tqdm_class (like tqdm_discord)\n* Minor fixes\n\n\n0.1.0 (2020-03-07)\n------------------\n\n* Some updates in progress reporting and documentation.\n\n0.0.1 (2020-03-05)\n------------------\n\n* First release on PyPI.\n\n\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "PQDM is a TQDM and concurrent futures wrapper to allow enjoyable paralellization of progress bars.",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/niedakh/pqdm"
},
"split_keywords": [
"pqdm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9eb7720988acdc9b5805cd1ef311aa75d6fd1c5438b87f4add1ec8d11f78d63b",
"md5": "24371b140044fd58063f83447f5cb861",
"sha256": "0da33a22ebee349a047abf8ef7fd00d85403638101d5e374b421a74188231b62"
},
"downloads": -1,
"filename": "pqdm-0.2.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "24371b140044fd58063f83447f5cb861",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 6765,
"upload_time": "2022-02-14T10:16:18",
"upload_time_iso_8601": "2022-02-14T10:16:18.824154Z",
"url": "https://files.pythonhosted.org/packages/9e/b7/720988acdc9b5805cd1ef311aa75d6fd1c5438b87f4add1ec8d11f78d63b/pqdm-0.2.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fbdd1b2ae6551a32bf8ae26b90c6e191a889bee5050bf23c88021761fbca03d1",
"md5": "8b5944d3bad9672d75ca0690e34edbec",
"sha256": "d99d01fe498d327b440ebfe08c14c84e0dc9ecce6172ef9a31f96bb1aaf4e9e3"
},
"downloads": -1,
"filename": "pqdm-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "8b5944d3bad9672d75ca0690e34edbec",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 13899,
"upload_time": "2022-02-14T10:16:20",
"upload_time_iso_8601": "2022-02-14T10:16:20.675625Z",
"url": "https://files.pythonhosted.org/packages/fb/dd/1b2ae6551a32bf8ae26b90c6e191a889bee5050bf23c88021761fbca03d1/pqdm-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-02-14 10:16:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "niedakh",
"github_project": "pqdm",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "pqdm"
}
JSON
