automatic import of python-nbresuse

3 files changed, 383 insertions, 0 deletions

diff --git a/.gitignore b/.gitignore
index e69de29..5954851 100644
--- a/.gitignore
+++ b/.gitignore
@@ -0,0 +1 @@
+/nbresuse-0.4.0.tar.gz
diff --git a/python-nbresuse.spec b/python-nbresuse.spec
new file mode 100644
index 0000000..e03fe05
--- /dev/null
+++ b/python-nbresuse.spec
@@ -0,0 +1,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
+
+![Github Actions Status](https://github.com/yuvipanda/nbresuse/workflows/Tests/badge.svg)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/yuvipanda/nbresuse/stable)
+[![PyPI](https://img.shields.io/pypi/v/nbresuse)](https://pypi.python.org/pypi/nbresuse)
+[![PyPI](https://img.shields.io/pypi/l/nbresuse)](https://pypi.python.org/pypi/nbresuse)
+[![GitHub](https://img.shields.io/badge/issue_tracking-github-blue?logo=github)](https://github.com/yuvipanda/nbresuse/issues)
+
+![Screenshot with memory limit](screenshot.png)
+
+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
+
+![Screenshot with memory warning](warn-screenshot.png)
+
+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
+
+![Github Actions Status](https://github.com/yuvipanda/nbresuse/workflows/Tests/badge.svg)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/yuvipanda/nbresuse/stable)
+[![PyPI](https://img.shields.io/pypi/v/nbresuse)](https://pypi.python.org/pypi/nbresuse)
+[![PyPI](https://img.shields.io/pypi/l/nbresuse)](https://pypi.python.org/pypi/nbresuse)
+[![GitHub](https://img.shields.io/badge/issue_tracking-github-blue?logo=github)](https://github.com/yuvipanda/nbresuse/issues)
+
+![Screenshot with memory limit](screenshot.png)
+
+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
+
+![Screenshot with memory warning](warn-screenshot.png)
+
+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
+
+![Github Actions Status](https://github.com/yuvipanda/nbresuse/workflows/Tests/badge.svg)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/yuvipanda/nbresuse/stable)
+[![PyPI](https://img.shields.io/pypi/v/nbresuse)](https://pypi.python.org/pypi/nbresuse)
+[![PyPI](https://img.shields.io/pypi/l/nbresuse)](https://pypi.python.org/pypi/nbresuse)
+[![GitHub](https://img.shields.io/badge/issue_tracking-github-blue?logo=github)](https://github.com/yuvipanda/nbresuse/issues)
+
+![Screenshot with memory limit](screenshot.png)
+
+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
+
+![Screenshot with memory warning](warn-screenshot.png)
+
+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
+* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 0.4.0-1
+- Package Spec generated
diff --git a/sources b/sources
new file mode 100644
index 0000000..771d3eb
--- /dev/null
+++ b/sources
@@ -0,0 +1 @@
+6428c106ec12f98d1fce9932bf260f1e  nbresuse-0.4.0.tar.gz