diff options
author | David Lord <davidism@gmail.com> | 2021-07-04 07:49:20 -0700 |
---|---|---|
committer | David Lord <davidism@gmail.com> | 2021-07-04 07:49:20 -0700 |
commit | cd9455920c936ebab235ae4fb54e4b183b4c77e2 (patch) | |
tree | 19224a455b0135333d8f05c4bf236b10fa64968d /docs | |
parent | e5536b2d24f1ce388e1b13b850222104a2ee1d51 (diff) | |
download | click-cd9455920c936ebab235ae4fb54e4b183b4c77e2.tar.gz |
mention tqdm in progress bar docs
Diffstat (limited to 'docs')
-rw-r--r-- | docs/utils.rst | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/docs/utils.rst b/docs/utils.rst index fb7d3c2..995c171 100644 --- a/docs/utils.rst +++ b/docs/utils.rst @@ -339,13 +339,18 @@ Example usage:: Showing Progress Bars --------------------- -.. versionadded:: 2.0 - Sometimes, you have command line scripts that need to process a lot of data, but you want to quickly show the user some progress about how long that will take. Click supports simple progress bar rendering for that through the :func:`progressbar` function. +.. note:: + + If you find that you have requirements beyond what Click's progress + bar supports, try using `tqdm`_. + + .. _tqdm: https://tqdm.github.io/ + The basic usage is very simple: the idea is that you have an iterable that you want to operate on. For each item in the iterable it might take some time to do processing. So say you have a loop like this:: |