Rooba
/
tqdm
mirror of https://github.com/tqdm/tqdm.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update readme

This commit is contained in:
Hadrien Mary 2015-06-15 11:05:53 +02:00
parent 38d18f18cc
commit 5671e43757
1 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -5,7 +5,7 @@
[![Build Status](https://travis-ci.org/tqdm/tqdm.svg?branch=master)](https://travis-ci.org/tqdm/tqdm)
[![Coverage Status](https://coveralls.io/repos/tqdm/tqdm/badge.svg)](https://coveralls.io/r/tqdm/tqdm)
Instantly make your loops show a progress meter - just wrap any iterable with
Instantly make your loops show a progress meter - just wrap any iterable with
"tqdm(iterable)", and you're done!
tqdm (read ta<i>qa</i>dum, تقدّم) means "progress" in arabic.
@ -27,14 +27,14 @@ pip install -e git+https://github.com/tqdm/tqdm.git#egg=master
```python
def tqdm(iterable, desc='', total=None,
leave=False, file=sys.stderr,
mininterval=0.5, miniters=1):
mininterval=0.5, miniters=1):
"""Get an iterable object, and return an iterator which acts exactly like
the iterable, but prints a progress meter and updates it every time a
value is requested.
Parameters
----------
iterable: iterable
iterable: iterable
Iterable to show progress for.
desc: str, optional
A short string, describing the progress, that is added in the beginning
@ -46,15 +46,15 @@ def tqdm(iterable, desc='', total=None,
A file-like object to output the progress message to. By default,
sys.stderr is used.
leave : bool, optional
If it is False (default), tqdm deletes its traces from screen after
If it is False (default), tqdm deletes its traces from screen after
it has finished iterating over all elements.
mininterval : float, optional
If less than mininterval seconds have passed since the last progress
If less than mininterval seconds have passed since the last progress
meter update, it is not updated again (default: 0.5).
miniters : float, optional
If less than miniters iterations have passed since the last progress
If less than miniters iterations have passed since the last progress
meter update, it is not updated again (default: 1).
"""
def trange(*args, **kwargs):
@ -64,9 +64,17 @@ def trange(*args, **kwargs):
## Contributions
To run the testing suite please make sure tox (http://tox.testrun.org/)
To run the testing suite please make sure tox (http://tox.testrun.org/)
is installed, then type `tox` from the command line.
Alternatively if you don't want to use `tox`, a Makefile is provided with the following command:
```sh
$ make flake8
$ make test
$ make coverage
```
## License
[MIT LICENSE](LICENSE).