Metadata-Version: 2.1
Name: sshspawner
Version: 0.0.0a0
Summary: SSH Spawner: A custom spawner for Jupyterhub to spawn                    notebooks over SSH
Home-page: https://github.com/rasmunk/sshspawner.git
Author: Rasmus Munk
Author-email: munk1@live.dk
License: BSD
Keywords: Interactive,Interpreter,Shell,Web,JupyterHub,Spawner
Platform: Linux
Platform: Mac OS X
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: asyncssh
Requires-Dist: jupyterhub
Provides-Extra: dev
Requires-Dist: flake8 (==3.8.4) ; extra == 'dev'
Requires-Dist: black (==20.8b1) ; extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'


==========
sshspawner
==========

The ``sshspawner`` enables JupyterHub to spawn single-user notebook servers on remote hosts over SSH.

Features
--------

* Supports SSH key-based authentication
* Pool of remote hosts for spawning notebook servers
* Extensible custom load-balacing for remote host pool
* Remote-side scripting to return IP and port

Requirements
------------

* Python 3.6 - 3.9
* [JupyterHub](http://jupyter.org/install)
* [AsyncSSH](https://asyncssh.readthedocs.io/en/latest/#installation)

Installation
------------

The ``sshspawner`` is installed with the following command::

    pip3 install .


Install [scripts/get_port.py](scripts/get_port.py) on remote host and set correct path for `c.SSHSpawner.remote_port_command` in [jupyterhub_config.py](jupyterhub_config.py)

Configuration
-------------

See [jupyterhub_config.py](jupyterhub_config.py) for a sample configuration.
Adjust values for your installation.

License
-------

All code is licensed under the terms of the revised BSD license.

Credit 
------

Based on the reference implementation by the NERSC [SSHSpawner](https://github.com/NERSC/sshspawner)

Resources
---------

- [Documentation for JupyterHub](https://jupyterhub.readthedocs.io)
- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/latest/index.html) | [PDF](https://media.readthedocs.org/pdf/jupyter/latest/jupyter.pdf)
- [Project Jupyter website](https://jupyter.org)



