ztimson/py-bar
ztimson/py-bar
1
0
Fork 0
Code Issues Pull Requests Releases Activity

Update README.md

Browse Source
This commit is contained in:
Zakary Timson 2017-07-31 17:50:49 -04:00 committed by GitHub
parent f4089bfe60
commit 7b34982745
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -75,6 +75,7 @@ display - automaticly display the to string with each iteration
bar_format - string which dictates how things are displayed ex "{elapesed} - {eta}" could look like: 00:00 - 00:10. See the statistics portion to see what can be displayed bar_format - string which dictates how things are displayed ex "{elapesed} - {eta}" could look like: 00:00 - 00:10. See the statistics portion to see what can be displayed
**Available Statistics** **Available Statistics**
elapsed - running time of iterator. displayed as: mm:ss elapsed - running time of iterator. displayed as: mm:ss
percentage - percentage of completion. displayed as: 100% percentage - percentage of completion. displayed as: 100%
@ -85,9 +86,10 @@ fraction - current / end. displayed as: [100/100]
rate - iterations per second. displayed as: 2.00/s (unit can be changed, see units attribute) rate - iterations per second. displayed as: 2.00/s (unit can be changed, see units attribute)
eat - estimated time until completion. displayed as: mm:ss eta - estimated time until completion. displayed as: mm:ss
**Methods** **Methods**
elapsed(self) - running time of iterator elapsed(self) - running time of iterator
estimated_time(self) - estimated time until iterator completes estimated_time(self) - estimated time until iterator completes
@ -101,4 +103,5 @@ per_second - calculates the rate or speed of iterations per second
percentage - floating point of completion percentage - floating point of completion
### Bug Reporting ### Bug Reporting
Please submit bugs to the github [issue tracker](https://github.com/zaktimson/progressbar/issues) Please submit bugs to the github [issue tracker](https://github.com/zaktimson/progressbar/issues)