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

Extracted RELEASE info from CONTRIBUTE

This commit is contained in:
Stephen L 2015-10-11 19:18:30 +02:00 committed by Casper da Costa-Luis
parent 64b6f29177
commit 5910fe139b
2 changed files with 19 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CONTRIBUTE
View File

@ -30,11 +30,8 @@ TESTING
To test functionality on your machine (such as before submitting a Pull
Request), there are a number of unit tests.
To run the tests,
- install `tox`
- `cd` to the root of the `tqdm` directory (in the same folder as this file)
- run the following commands:
To run the test, cd to the root of the tqdm folder (in the same folder
as this file), and then type the following (you need to install `tox`):
```
make test

20
README.rst
View File

@ -11,6 +11,12 @@ tqdm (read taqadum, تقدّم) means "progress" in arabic.
Instantly make your loops show a progress meter - just wrap any
iterable with "tqdm(iterable)", and you're done!
.. code:: python
from tqdm import tqdm
for i in tqdm(range(16)):
...
Here's what the output looks like:
76%\|████████████████████\ ````` ````` \| 7641/10000 [00:34<00:10,
@ -29,11 +35,19 @@ version is much more visually appealing.
Installation
------------
Latest pypi stable release
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code:: sh
# Latest stable release on pypi
pip install tqdm
# Latest development release on github
Latest development release on github
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Pull and install in the current directory:
::
pip install -e git+https://github.com/tqdm/tqdm.git@master#egg=tqdm
Documentation
@ -201,7 +215,7 @@ with the following command:
$ make test
$ make coverage
See also the CONTRIBUTE file for more information.
See the `CONTRIBUTE <CONTRIBUTE>`__ file for more information.
License
-------