Metadata-Version: 2.4
Name: swanhub
Version: 1.0.16
Summary: Custom SWAN templates and handlers for JupyterHub
Project-URL: Homepage, https://github.com/swan-cern/jupyterhub-extensions
Project-URL: GitHub, https://github.com/swan-cern/jupyterhub-extensions
Author: SWAN Admins
License-Expression: AGPL-3.0
Keywords: CERN,JupyterHub,SWAN
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: System Administrators
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Requires-Dist: jupyterhub==5.4.3
Requires-Dist: sentry-sdk[pure-eval,tornado]==2.56.0
Description-Content-Type: text/markdown

# SwanHub

JupyterHub wrapper that automatically configures the SWAN templates and handlers.

These handlers replace the default ones with slightly modified versions (for example, the user info api endpoint provides information about the auth state, which is hidden in the default implementation).

## Requirements

This module requires and installs JupyterHub.

## Installation

Install the package

```bash
pip install swanhub
```

To have the proper css, it is necessary to download a release from https://github.com/swan-cern/common into the folder `/usr/local/share/jupyterhub/static/swan/`.

## Usage

Start SwanHub as you would for JupyterHub, and with the same configurations. Example:

```bash
swanhub --config /path/to/my/jupyterhub_config.py
```