1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
|
%global _empty_manifest_terminate_build 0
Name: python-nbresuse
Version: 0.4.0
Release: 1
Summary: Simple Jupyter extension to show how much resources (RAM) your notebook is using
License: BSD
URL: https://github.com/yuvipanda/nbresuse
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/92/20/c652e11b12874222db2214fc2cbb86e83c45b9f2d8f49b27910328824893/nbresuse-0.4.0.tar.gz
BuildArch: noarch
Requires: python3-notebook
Requires: python3-prometheus-client
Requires: python3-psutil
Requires: python3-autopep8
Requires: python3-black
Requires: python3-pytest
Requires: python3-flake8
Requires: python3-pytest-cov
Requires: python3-mock
%description
**[Installation](#installation)** |
**[Configuration](#configuration)** |
**[Resources Displayed](#resources-displayed)** |
**[Contributing](#contributing)**
# NBResuse
[](https://mybinder.org/v2/gh/yuvipanda/nbresuse/stable)
[](https://pypi.python.org/pypi/nbresuse)
[](https://pypi.python.org/pypi/nbresuse)
[](https://github.com/yuvipanda/nbresuse/issues)
NB Resource Usage (NBResuse) is a small extension for Jupyter Notebooks that
displays an indication of how much resources your current notebook server and
its children (kernels, terminals, etc) are using. This is displayed in the
main toolbar in the notebook itself, refreshing every 5s.
## Installation
You can currently install this package from PyPI.
```bash
pip install nbresuse
```
**If your notebook version is < 5.3**, you need to enable the extension manually.
```
jupyter serverextension enable --py nbresuse --sys-prefix
jupyter nbextension install --py nbresuse --sys-prefix
jupyter nbextension enable --py nbresuse --sys-prefix
```
## Configuration
### Memory Limit
`nbresuse` can display a memory limit (but not enforce it). You can set this
in several ways:
1. `MEM_LIMIT` environment variable. This is set by [JupyterHub](https://github.com/jupyterhub/jupyterhub/)
if using a spawner that supports it.
2. In the commandline when starting `jupyter notebook`, as `--ResourceUseDisplay.mem_limit`.
3. In your Jupyter notebook [traitlets](https://traitlets.readthedocs.io/en/stable/) config file
The limit needs to be set as an integer in Bytes.
### Memory usage warning threshold
The background of the resource display can be changed to red when the user is near a memory limit.
The threshold for this warning can be configured as a fraction of the memory limit.
If you want to flash the warning to the user when they are within 10% of the memory limit, you
can set the parameter `--ResourceUseDisplay.mem_warning_threshold=0.1`.
### CPU Usage
`nbresuse` can also track CPU usage and report a `cpu_percent` value as part of the `/metrics` response.
You can set the `cpu_limit` in several ways:
1. `CPU_LIMIT` environment variable. This is set by [JupyterHub](https://github.com/jupyterhub/jupyterhub/)
if using a spawner that supports it.
2. In the command line when starting `jupyter notebook`, as `--ResourceUseDisplay.cpu_limit`.
3. In your Jupyter notebook [traitlets](https://traitlets.readthedocs.io/en/stable/) config file
The limit corresponds to the number of cpus the user has access to, but does not enforce it.
Additionally, you can set the `track_cpu_percent` trait to enable CPU usage tracking (disabled by default):
```python
c = get_config()
c.NotebookApp.ResourceUseDisplay.track_cpu_percent = True
```
As a command line argument:
```bash
jupyter notebook --ResourceUseDisplay.track_cpu_percent=True
```
## Resources Displayed
Currently the server extension only reports memory usage (just RSS) and CPU usage. Other metrics will be
added in the future as needed.
The notebook extension currently doesn't show CPU usage, only memory usage.
## Contributing
If you would like to contribute to the project, please read the [`CONTRIBUTING.md`](CONTRIBUTING.md). The `CONTRIBUTING.md` file
explains how to set up a development installation and how to run the test suite.
%package -n python3-nbresuse
Summary: Simple Jupyter extension to show how much resources (RAM) your notebook is using
Provides: python-nbresuse
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-nbresuse
**[Installation](#installation)** |
**[Configuration](#configuration)** |
**[Resources Displayed](#resources-displayed)** |
**[Contributing](#contributing)**
# NBResuse
[](https://mybinder.org/v2/gh/yuvipanda/nbresuse/stable)
[](https://pypi.python.org/pypi/nbresuse)
[](https://pypi.python.org/pypi/nbresuse)
[](https://github.com/yuvipanda/nbresuse/issues)
NB Resource Usage (NBResuse) is a small extension for Jupyter Notebooks that
displays an indication of how much resources your current notebook server and
its children (kernels, terminals, etc) are using. This is displayed in the
main toolbar in the notebook itself, refreshing every 5s.
## Installation
You can currently install this package from PyPI.
```bash
pip install nbresuse
```
**If your notebook version is < 5.3**, you need to enable the extension manually.
```
jupyter serverextension enable --py nbresuse --sys-prefix
jupyter nbextension install --py nbresuse --sys-prefix
jupyter nbextension enable --py nbresuse --sys-prefix
```
## Configuration
### Memory Limit
`nbresuse` can display a memory limit (but not enforce it). You can set this
in several ways:
1. `MEM_LIMIT` environment variable. This is set by [JupyterHub](https://github.com/jupyterhub/jupyterhub/)
if using a spawner that supports it.
2. In the commandline when starting `jupyter notebook`, as `--ResourceUseDisplay.mem_limit`.
3. In your Jupyter notebook [traitlets](https://traitlets.readthedocs.io/en/stable/) config file
The limit needs to be set as an integer in Bytes.
### Memory usage warning threshold
The background of the resource display can be changed to red when the user is near a memory limit.
The threshold for this warning can be configured as a fraction of the memory limit.
If you want to flash the warning to the user when they are within 10% of the memory limit, you
can set the parameter `--ResourceUseDisplay.mem_warning_threshold=0.1`.
### CPU Usage
`nbresuse` can also track CPU usage and report a `cpu_percent` value as part of the `/metrics` response.
You can set the `cpu_limit` in several ways:
1. `CPU_LIMIT` environment variable. This is set by [JupyterHub](https://github.com/jupyterhub/jupyterhub/)
if using a spawner that supports it.
2. In the command line when starting `jupyter notebook`, as `--ResourceUseDisplay.cpu_limit`.
3. In your Jupyter notebook [traitlets](https://traitlets.readthedocs.io/en/stable/) config file
The limit corresponds to the number of cpus the user has access to, but does not enforce it.
Additionally, you can set the `track_cpu_percent` trait to enable CPU usage tracking (disabled by default):
```python
c = get_config()
c.NotebookApp.ResourceUseDisplay.track_cpu_percent = True
```
As a command line argument:
```bash
jupyter notebook --ResourceUseDisplay.track_cpu_percent=True
```
## Resources Displayed
Currently the server extension only reports memory usage (just RSS) and CPU usage. Other metrics will be
added in the future as needed.
The notebook extension currently doesn't show CPU usage, only memory usage.
## Contributing
If you would like to contribute to the project, please read the [`CONTRIBUTING.md`](CONTRIBUTING.md). The `CONTRIBUTING.md` file
explains how to set up a development installation and how to run the test suite.
%package help
Summary: Development documents and examples for nbresuse
Provides: python3-nbresuse-doc
%description help
**[Installation](#installation)** |
**[Configuration](#configuration)** |
**[Resources Displayed](#resources-displayed)** |
**[Contributing](#contributing)**
# NBResuse
[](https://mybinder.org/v2/gh/yuvipanda/nbresuse/stable)
[](https://pypi.python.org/pypi/nbresuse)
[](https://pypi.python.org/pypi/nbresuse)
[](https://github.com/yuvipanda/nbresuse/issues)
NB Resource Usage (NBResuse) is a small extension for Jupyter Notebooks that
displays an indication of how much resources your current notebook server and
its children (kernels, terminals, etc) are using. This is displayed in the
main toolbar in the notebook itself, refreshing every 5s.
## Installation
You can currently install this package from PyPI.
```bash
pip install nbresuse
```
**If your notebook version is < 5.3**, you need to enable the extension manually.
```
jupyter serverextension enable --py nbresuse --sys-prefix
jupyter nbextension install --py nbresuse --sys-prefix
jupyter nbextension enable --py nbresuse --sys-prefix
```
## Configuration
### Memory Limit
`nbresuse` can display a memory limit (but not enforce it). You can set this
in several ways:
1. `MEM_LIMIT` environment variable. This is set by [JupyterHub](https://github.com/jupyterhub/jupyterhub/)
if using a spawner that supports it.
2. In the commandline when starting `jupyter notebook`, as `--ResourceUseDisplay.mem_limit`.
3. In your Jupyter notebook [traitlets](https://traitlets.readthedocs.io/en/stable/) config file
The limit needs to be set as an integer in Bytes.
### Memory usage warning threshold
The background of the resource display can be changed to red when the user is near a memory limit.
The threshold for this warning can be configured as a fraction of the memory limit.
If you want to flash the warning to the user when they are within 10% of the memory limit, you
can set the parameter `--ResourceUseDisplay.mem_warning_threshold=0.1`.
### CPU Usage
`nbresuse` can also track CPU usage and report a `cpu_percent` value as part of the `/metrics` response.
You can set the `cpu_limit` in several ways:
1. `CPU_LIMIT` environment variable. This is set by [JupyterHub](https://github.com/jupyterhub/jupyterhub/)
if using a spawner that supports it.
2. In the command line when starting `jupyter notebook`, as `--ResourceUseDisplay.cpu_limit`.
3. In your Jupyter notebook [traitlets](https://traitlets.readthedocs.io/en/stable/) config file
The limit corresponds to the number of cpus the user has access to, but does not enforce it.
Additionally, you can set the `track_cpu_percent` trait to enable CPU usage tracking (disabled by default):
```python
c = get_config()
c.NotebookApp.ResourceUseDisplay.track_cpu_percent = True
```
As a command line argument:
```bash
jupyter notebook --ResourceUseDisplay.track_cpu_percent=True
```
## Resources Displayed
Currently the server extension only reports memory usage (just RSS) and CPU usage. Other metrics will be
added in the future as needed.
The notebook extension currently doesn't show CPU usage, only memory usage.
## Contributing
If you would like to contribute to the project, please read the [`CONTRIBUTING.md`](CONTRIBUTING.md). The `CONTRIBUTING.md` file
explains how to set up a development installation and how to run the test suite.
%prep
%autosetup -n nbresuse-0.4.0
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-nbresuse -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Sun Apr 23 2023 Python_Bot <Python_Bot@openeuler.org> - 0.4.0-1
- Package Spec generated
|
