diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-jhub-client.spec | 654 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 656 insertions, 0 deletions
@@ -0,0 +1 @@ +/jhub-client-0.1.7.tar.gz diff --git a/python-jhub-client.spec b/python-jhub-client.spec new file mode 100644 index 0000000..8bfe0da --- /dev/null +++ b/python-jhub-client.spec @@ -0,0 +1,654 @@ +%global _empty_manifest_terminate_build 0 +Name: python-jhub-client +Version: 0.1.7 +Release: 1 +Summary: Library and Client for managing, benchmarking, and interacting with jupyterhub +License: BSD License +URL: https://github.com/Quansight/jhub-client +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/f1/2d/e654c774e332a256147bd2effd4d2177ba38616e14c67939d84021336f72/jhub-client-0.1.7.tar.gz +BuildArch: noarch + + +%description +# JupyterHub Client + + + +Automation of JupyterHub + +# Install + +```shell +pip install jhub-client +``` + +# Command Line Usage + +Below are some example use cases of the tool. Note that with an admin +api token you can impersonate users and create temporary +users. Service api tokens do not have an associated user therefore +must run as existing users or temporary users. + +Set the api token used for `jhub-client`. + +```shell +export JUPYTERHUB_API_TOKEN=<api-token> +``` + +Optionally basic authentication can be used instead of token based +(not recommended but needed in some use cases). In which case +`username` and `password` are required. + +```shell +export JUPYTERHUB_USERNAME=<username> +export JUPYTERHUB_PASSWORD=<password> +``` + +## Token + +```shell +$ jhubctl token --help +usage: __main__.py token [-h] [--hub HUB] [--name NAME] + +optional arguments: + -h, --help show this help message and exit + --hub HUB url for running jupyterhub cluster + --name NAME name to give to jupyterhub api token +``` + +A simple command line utility can be used to create a token. This only +supports basic authentication (`username` and `password`) login to the +jupyterhub cluster. + +## Run + +```shell +$ jhubctl run --help +usage: __main__.py run [-h] -n NOTEBOOK [--auth-type {token,basic}] [--hub HUB] [-u USERNAME] + [--user-options USER_OPTIONS] [--temporary-user] [-d] [--stop-server] [--validate] + [--kernel-spec KERNEL_SPEC] [--output-filename OUTPUT_FILENAME] + +optional arguments: + -h, --help show this help message and exit + -n NOTEBOOK, --notebook NOTEBOOK + notebook to run + --auth-type {token,basic} + jupyterhub authentication type to use with default of token based + --hub HUB url for running jupyterhub cluster with default of 'http://localhost:8000' + -u USERNAME, --username USERNAME + username to run notebook as + --user-options USER_OPTIONS + json object representing user server options + --temporary-user create user temporarily if does not exist + -d, --daemonize run notebook asyncronously + --stop-server stop server after completion of notebook + --validate validate notebook output matches + --kernel-spec KERNEL_SPEC + kernel spec to launch is not specified will use default + --output-filename OUTPUT_FILENAME + output filename for results of running notebook +``` + +### Run notebook as given token user syncronously + +You can run a given notebook as a pre-existing user syncronously. The +api token either has to be for the given user or an admin token. + +```shell +jhubctl --verbose run --notebook <notebook> --hub <hub_url> +``` + +### Run notebook as given token user syncronously and validate notebook output matches + +You can run a given notebook as a pre-existing user syncronously. The +api token either has to be for the given user or an admin token. + +```shell +jhubctl run --notebook <notebook> --hub <hub_url> --validate +``` + +### Run notebook as given token user asyncronously and shutdown server after completion + +You can run a given notebook as a pre-existing user asyncronously and +stop server after completion. The api token either has to be for the +given user or an admin token. + +```shell +jhubctl run --notebook <notebook> --hub <hub_url> --daemonize --stop-server +``` + +### Run notebook as given token user with user options + +While this is an advanced use case, it is often times encountered +with kubernetes jupyerhub clusters where you may want to select a +given profile e.g. small, medium, gpu jupyterlab session. For these +clusters you must supply `--user-options='{"profile": 0}'` where 0 is +replaced with the index of the profile you would like to choose. It is +possible for other more customized jupyterhub clusters that different +options must be used. + +```shell +jhubctl run --notebook <notebook> --hub <hub_url> --user-options='{"profile": 1}' +``` + +### Run notebook as given token user with user options + +You can run a given notebook with any available kernel spec. + +```shell +jhubctl run --notebook <notebook> --hub <hub_url> --kernel-spec=python3 +``` + +### Run a given notebook as a temporary user + +Additionally you can temporarily create a user `user-<uuid>` or supply +the temporary user's username. The username will be deleted upon +completion. The api token requires admin permissions. + +```shell +jhubctl run --temporary-user --notebook <notebook> --hub <hub_url> [--username <username>] +``` + +# Testing + +Bring up test jupyterhub cluster + +```shell +cd tests/assets +docker-compose up --build +``` + +Run unit tests + +```shell +pytest +``` + +# FAQ + +## Creating an API Token + +Login to the given jupyterhub cluster + + + +Access the hub control page. The url will be `<hub_url>/hub/home`. + + + +Click on `Token` in top left corner and request new api token. This +token will have the permissions of the user. Make sure to set the +environment variable `JUPYTERHUB_API_TOKEN` to the value of the given +token. + + + +If you want to add a service token instead edit the jupyterhub +configuration. + +```python +c.JupyterHub.services = [ + { + 'name': '<my-service-name>', + 'api_token': '<my-super-secret-long-token>', + 'oauth_no_confirm': True, + 'admin': True + } +] +``` + +# Code of Conduct + +To guarantee a welcoming and friendly community, we require contributors to follow our [Code of Conduct](https://github.com/Quansight/.github/blob/master/CODE_OF_CONDUCT.md). + +# License + +[jhub-client](https://github.com/Quansight/jhub-client/blob/main/LICENSE) +is BSD-3 Licensed + +%package -n python3-jhub-client +Summary: Library and Client for managing, benchmarking, and interacting with jupyterhub +Provides: python-jhub-client +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-jhub-client +# JupyterHub Client + + + +Automation of JupyterHub + +# Install + +```shell +pip install jhub-client +``` + +# Command Line Usage + +Below are some example use cases of the tool. Note that with an admin +api token you can impersonate users and create temporary +users. Service api tokens do not have an associated user therefore +must run as existing users or temporary users. + +Set the api token used for `jhub-client`. + +```shell +export JUPYTERHUB_API_TOKEN=<api-token> +``` + +Optionally basic authentication can be used instead of token based +(not recommended but needed in some use cases). In which case +`username` and `password` are required. + +```shell +export JUPYTERHUB_USERNAME=<username> +export JUPYTERHUB_PASSWORD=<password> +``` + +## Token + +```shell +$ jhubctl token --help +usage: __main__.py token [-h] [--hub HUB] [--name NAME] + +optional arguments: + -h, --help show this help message and exit + --hub HUB url for running jupyterhub cluster + --name NAME name to give to jupyterhub api token +``` + +A simple command line utility can be used to create a token. This only +supports basic authentication (`username` and `password`) login to the +jupyterhub cluster. + +## Run + +```shell +$ jhubctl run --help +usage: __main__.py run [-h] -n NOTEBOOK [--auth-type {token,basic}] [--hub HUB] [-u USERNAME] + [--user-options USER_OPTIONS] [--temporary-user] [-d] [--stop-server] [--validate] + [--kernel-spec KERNEL_SPEC] [--output-filename OUTPUT_FILENAME] + +optional arguments: + -h, --help show this help message and exit + -n NOTEBOOK, --notebook NOTEBOOK + notebook to run + --auth-type {token,basic} + jupyterhub authentication type to use with default of token based + --hub HUB url for running jupyterhub cluster with default of 'http://localhost:8000' + -u USERNAME, --username USERNAME + username to run notebook as + --user-options USER_OPTIONS + json object representing user server options + --temporary-user create user temporarily if does not exist + -d, --daemonize run notebook asyncronously + --stop-server stop server after completion of notebook + --validate validate notebook output matches + --kernel-spec KERNEL_SPEC + kernel spec to launch is not specified will use default + --output-filename OUTPUT_FILENAME + output filename for results of running notebook +``` + +### Run notebook as given token user syncronously + +You can run a given notebook as a pre-existing user syncronously. The +api token either has to be for the given user or an admin token. + +```shell +jhubctl --verbose run --notebook <notebook> --hub <hub_url> +``` + +### Run notebook as given token user syncronously and validate notebook output matches + +You can run a given notebook as a pre-existing user syncronously. The +api token either has to be for the given user or an admin token. + +```shell +jhubctl run --notebook <notebook> --hub <hub_url> --validate +``` + +### Run notebook as given token user asyncronously and shutdown server after completion + +You can run a given notebook as a pre-existing user asyncronously and +stop server after completion. The api token either has to be for the +given user or an admin token. + +```shell +jhubctl run --notebook <notebook> --hub <hub_url> --daemonize --stop-server +``` + +### Run notebook as given token user with user options + +While this is an advanced use case, it is often times encountered +with kubernetes jupyerhub clusters where you may want to select a +given profile e.g. small, medium, gpu jupyterlab session. For these +clusters you must supply `--user-options='{"profile": 0}'` where 0 is +replaced with the index of the profile you would like to choose. It is +possible for other more customized jupyterhub clusters that different +options must be used. + +```shell +jhubctl run --notebook <notebook> --hub <hub_url> --user-options='{"profile": 1}' +``` + +### Run notebook as given token user with user options + +You can run a given notebook with any available kernel spec. + +```shell +jhubctl run --notebook <notebook> --hub <hub_url> --kernel-spec=python3 +``` + +### Run a given notebook as a temporary user + +Additionally you can temporarily create a user `user-<uuid>` or supply +the temporary user's username. The username will be deleted upon +completion. The api token requires admin permissions. + +```shell +jhubctl run --temporary-user --notebook <notebook> --hub <hub_url> [--username <username>] +``` + +# Testing + +Bring up test jupyterhub cluster + +```shell +cd tests/assets +docker-compose up --build +``` + +Run unit tests + +```shell +pytest +``` + +# FAQ + +## Creating an API Token + +Login to the given jupyterhub cluster + + + +Access the hub control page. The url will be `<hub_url>/hub/home`. + + + +Click on `Token` in top left corner and request new api token. This +token will have the permissions of the user. Make sure to set the +environment variable `JUPYTERHUB_API_TOKEN` to the value of the given +token. + + + +If you want to add a service token instead edit the jupyterhub +configuration. + +```python +c.JupyterHub.services = [ + { + 'name': '<my-service-name>', + 'api_token': '<my-super-secret-long-token>', + 'oauth_no_confirm': True, + 'admin': True + } +] +``` + +# Code of Conduct + +To guarantee a welcoming and friendly community, we require contributors to follow our [Code of Conduct](https://github.com/Quansight/.github/blob/master/CODE_OF_CONDUCT.md). + +# License + +[jhub-client](https://github.com/Quansight/jhub-client/blob/main/LICENSE) +is BSD-3 Licensed + +%package help +Summary: Development documents and examples for jhub-client +Provides: python3-jhub-client-doc +%description help +# JupyterHub Client + + + +Automation of JupyterHub + +# Install + +```shell +pip install jhub-client +``` + +# Command Line Usage + +Below are some example use cases of the tool. Note that with an admin +api token you can impersonate users and create temporary +users. Service api tokens do not have an associated user therefore +must run as existing users or temporary users. + +Set the api token used for `jhub-client`. + +```shell +export JUPYTERHUB_API_TOKEN=<api-token> +``` + +Optionally basic authentication can be used instead of token based +(not recommended but needed in some use cases). In which case +`username` and `password` are required. + +```shell +export JUPYTERHUB_USERNAME=<username> +export JUPYTERHUB_PASSWORD=<password> +``` + +## Token + +```shell +$ jhubctl token --help +usage: __main__.py token [-h] [--hub HUB] [--name NAME] + +optional arguments: + -h, --help show this help message and exit + --hub HUB url for running jupyterhub cluster + --name NAME name to give to jupyterhub api token +``` + +A simple command line utility can be used to create a token. This only +supports basic authentication (`username` and `password`) login to the +jupyterhub cluster. + +## Run + +```shell +$ jhubctl run --help +usage: __main__.py run [-h] -n NOTEBOOK [--auth-type {token,basic}] [--hub HUB] [-u USERNAME] + [--user-options USER_OPTIONS] [--temporary-user] [-d] [--stop-server] [--validate] + [--kernel-spec KERNEL_SPEC] [--output-filename OUTPUT_FILENAME] + +optional arguments: + -h, --help show this help message and exit + -n NOTEBOOK, --notebook NOTEBOOK + notebook to run + --auth-type {token,basic} + jupyterhub authentication type to use with default of token based + --hub HUB url for running jupyterhub cluster with default of 'http://localhost:8000' + -u USERNAME, --username USERNAME + username to run notebook as + --user-options USER_OPTIONS + json object representing user server options + --temporary-user create user temporarily if does not exist + -d, --daemonize run notebook asyncronously + --stop-server stop server after completion of notebook + --validate validate notebook output matches + --kernel-spec KERNEL_SPEC + kernel spec to launch is not specified will use default + --output-filename OUTPUT_FILENAME + output filename for results of running notebook +``` + +### Run notebook as given token user syncronously + +You can run a given notebook as a pre-existing user syncronously. The +api token either has to be for the given user or an admin token. + +```shell +jhubctl --verbose run --notebook <notebook> --hub <hub_url> +``` + +### Run notebook as given token user syncronously and validate notebook output matches + +You can run a given notebook as a pre-existing user syncronously. The +api token either has to be for the given user or an admin token. + +```shell +jhubctl run --notebook <notebook> --hub <hub_url> --validate +``` + +### Run notebook as given token user asyncronously and shutdown server after completion + +You can run a given notebook as a pre-existing user asyncronously and +stop server after completion. The api token either has to be for the +given user or an admin token. + +```shell +jhubctl run --notebook <notebook> --hub <hub_url> --daemonize --stop-server +``` + +### Run notebook as given token user with user options + +While this is an advanced use case, it is often times encountered +with kubernetes jupyerhub clusters where you may want to select a +given profile e.g. small, medium, gpu jupyterlab session. For these +clusters you must supply `--user-options='{"profile": 0}'` where 0 is +replaced with the index of the profile you would like to choose. It is +possible for other more customized jupyterhub clusters that different +options must be used. + +```shell +jhubctl run --notebook <notebook> --hub <hub_url> --user-options='{"profile": 1}' +``` + +### Run notebook as given token user with user options + +You can run a given notebook with any available kernel spec. + +```shell +jhubctl run --notebook <notebook> --hub <hub_url> --kernel-spec=python3 +``` + +### Run a given notebook as a temporary user + +Additionally you can temporarily create a user `user-<uuid>` or supply +the temporary user's username. The username will be deleted upon +completion. The api token requires admin permissions. + +```shell +jhubctl run --temporary-user --notebook <notebook> --hub <hub_url> [--username <username>] +``` + +# Testing + +Bring up test jupyterhub cluster + +```shell +cd tests/assets +docker-compose up --build +``` + +Run unit tests + +```shell +pytest +``` + +# FAQ + +## Creating an API Token + +Login to the given jupyterhub cluster + + + +Access the hub control page. The url will be `<hub_url>/hub/home`. + + + +Click on `Token` in top left corner and request new api token. This +token will have the permissions of the user. Make sure to set the +environment variable `JUPYTERHUB_API_TOKEN` to the value of the given +token. + + + +If you want to add a service token instead edit the jupyterhub +configuration. + +```python +c.JupyterHub.services = [ + { + 'name': '<my-service-name>', + 'api_token': '<my-super-secret-long-token>', + 'oauth_no_confirm': True, + 'admin': True + } +] +``` + +# Code of Conduct + +To guarantee a welcoming and friendly community, we require contributors to follow our [Code of Conduct](https://github.com/Quansight/.github/blob/master/CODE_OF_CONDUCT.md). + +# License + +[jhub-client](https://github.com/Quansight/jhub-client/blob/main/LICENSE) +is BSD-3 Licensed + +%prep +%autosetup -n jhub-client-0.1.7 + +%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-jhub-client -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Wed May 10 2023 Python_Bot <Python_Bot@openeuler.org> - 0.1.7-1 +- Package Spec generated @@ -0,0 +1 @@ +149612bae75bfc11b6dcaa02019b0bf5 jhub-client-0.1.7.tar.gz |