Skip to content

Commit 062b383

Browse files
author
Zaytsev Dmitry
committed
restored requirements in install
1 parent 0bfd04c commit 062b383

File tree

2 files changed

+24
-23
lines changed

2 files changed

+24
-23
lines changed

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -129,60 +129,60 @@ Alternatively, the progress can be tracked via the equivalent generator function
129129
*`ProgBar(iterations, track_time=True, width=30, bar_char='#',
130130
stream=2, title='', monitor=False, update_interval=None, email=False))`*
131131

132-
- iterations : `int`
132+
- iterations : `int`
133133
Number of iterations for the iterative computation.
134-
- track_time : `bool` (default: `True`)
134+
- track_time : `bool` (default: `True`)
135135
Prints elapsed time when loop has finished.
136-
- width : `int` (default: 30)
136+
- width : `int` (default: 30)
137137
Sets the progress bar width in characters.
138-
- stream : `int` (default: 2).
138+
- stream : `int` (default: 2).
139139
Setting the output stream.
140140
Takes `1` for stdout, `2` for stderr, or a custom stream object
141-
- title : `str` (default: `''`)
141+
- title : `str` (default: `''`)
142142
Setting a title for the progress bar.
143-
- monitor : `bool` (default: `False`)
143+
- monitor : `bool` (default: `False`)
144144
Monitors CPU and memory usage if `True` (requires `psutil` package).
145-
- update_interval : float or int (default: `None`)
145+
- update_interval : float or int (default: `None`)
146146
The update_interval in seconds controls how often the progress
147147
is flushed to the screen.
148148
Automatic mode if `update_interval=None`.
149-
- email : `bool` (default: False)
149+
- email : `bool` (default: False)
150150
If `True` sends an email notification after finishing the task
151151

152152
##### ProgPercent
153153

154154
*`ProgPercent(iterations, track_time=True,
155155
stream=2, title='', monitor=False, update_interval=None, email=False)`*
156156

157-
- iterations : `int`
158-
Number of iterations for the iterative computation.
159-
- track_time : `bool` (default: `True`)
157+
- iterations : `int`
158+
Number of iterations for the iterative computation.
159+
- track_time : `bool` (default: `True`)
160160
Prints elapsed time when loop has finished.
161-
- stream : `int` (default: 2).
161+
- stream : `int` (default: 2).
162162
Setting the output stream.
163163
Takes `1` for stdout, `2` for stderr, or a custom stream object
164-
- title : `str` (default : `''`).
164+
- title : `str` (default : `''`).
165165
Setting a title for the percentage indicator.
166-
- monitor : `bool` (default: `False`)
166+
- monitor : `bool` (default: `False`)
167167
Monitors CPU and memory usage if `True` (requires `psutil` package).
168-
- update_interval : float or int (default: `None`)
168+
- update_interval : float or int (default: `None`)
169169
The update_interval in seconds controls how often the progress
170170
is flushed to the screen.
171171
Automatic mode if `update_interval=None`.
172-
- email : `bool` (default: False)
172+
- email : `bool` (default: False)
173173
If `True` sends an email notification after finishing the task
174174

175175
##### update method
176176

177177
*`update(iterations=1, item_id=None, force_flush=False)`*
178178

179-
- iterations : int (default: `1`)
179+
- iterations : int (default: `1`)
180180
default argument can be changed to integer values
181181
`>=1` in order to update the progress indicators more than once
182182
per iteration.
183-
- item_id : str (default: `None`)
183+
- item_id : str (default: `None`)
184184
Print an item_id sring behind the progress bar
185-
- force_flush : bool (default: `False`)
185+
- force_flush : bool (default: `False`)
186186
If True, flushes the progress indicator to the output screen
187187
in each iteration.
188188

@@ -192,11 +192,11 @@ Alternatively, the progress can be tracked via the equivalent generator function
192192

193193
*`pyprind.setup_email(smtp_server, smtp_port, username, password)`*
194194

195-
- smtp_server : str
196-
- smtp_port : int
197-
- username : str
195+
- smtp_server : str
196+
- smtp_port : int
197+
- username : str
198198
your full email username example (pyprind@pyprind.com)
199-
- password : str
199+
- password : str
200200
your password
201201

202202
If you want to use email notifications you can call function *`pyprind.setup_email`* only once and it will create an encrypted file with your email config and will be using it, if you want to change the email config just call *`pyprind.setup_email`* with new parameters and it will rewrite the email config file.

setup.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
packages=find_packages(),
2626
package_data={'': ['LICENSE',
2727
'README.md',
28+
'requirements.txt',
2829
'CHANGELOG.md',
2930
'CONTRIBUTING.md'],
3031
'tests': ['tests/test_percentage_indicator.py',

0 commit comments

Comments
 (0)