# jupyverse-auth

> A JupyterLab extension for authentication.

Latest version **0.1.0** (published 2021-09-10) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install jupyverse-auth
pnpm add jupyverse-auth
yarn add jupyverse-auth
bun add jupyverse-auth
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2021-09-10 |
| First published | 2021-09-10 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 18 |
| Unpacked size | 37.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | David Brochart |
| Maintainers | davidbrochart |
| Keywords | jupyter, jupyterlab, jupyterlab-extension |

## Links

- npm: https://www.npmjs.com/package/jupyverse-auth
- Repository: https://github.com/davidbrochart/jupyverse-auth
- Issues: https://github.com/davidbrochart/jupyverse-auth/issues
- npm.io page: https://npm.io/package/jupyverse-auth

## Dependencies (18)

- [lib0](https://npm.io/package/lib0.md) ^0.2.42
- [react](https://npm.io/package/react.md) ^17.0.2
- [y-protocols](https://npm.io/package/y-protocols.md) ^1.0.5
- [@lumino/widgets](https://npm.io/package/@lumino/widgets.md) ^1.19.0
- [@lumino/commands](https://npm.io/package/@lumino/commands.md) ^1.15.0
- [@lumino/coreutils](https://npm.io/package/@lumino/coreutils.md) ^1.8.0
- [@lumino/messaging](https://npm.io/package/@lumino/messaging.md) ^1.7.0
- [@jupyterlab/statedb](https://npm.io/package/@jupyterlab/statedb.md) ^3.1.0-rc.2
- [@jupyterlab/apputils](https://npm.io/package/@jupyterlab/apputils.md) ^3.1.0-rc.2
- [@jupyterlab/mainmenu](https://npm.io/package/@jupyterlab/mainmenu.md) ^3.1.0-rc.2
- [@jupyterlab/notebook](https://npm.io/package/@jupyterlab/notebook.md) ^3.1.0-rc.2
- [@jupyterlab/services](https://npm.io/package/@jupyterlab/services.md) ^6.1.0-rc.2
- [@jupyterlab/coreutils](https://npm.io/package/@jupyterlab/coreutils.md) ^5.1.0-rc.2
- [@jupyterlab/fileeditor](https://npm.io/package/@jupyterlab/fileeditor.md) ^3.1.0-rc.2
- [@jupyterlab/application](https://npm.io/package/@jupyterlab/application.md) ^3.1.0-rc.2
- [@jupyterlab/docprovider](https://npm.io/package/@jupyterlab/docprovider.md) ^3.1.0-rc.2
- [@jupyterlab/shared-models](https://npm.io/package/@jupyterlab/shared-models.md) ^3.1.0-rc.2
- [@jupyterlab/ui-components](https://npm.io/package/@jupyterlab/ui-components.md) ^3.1.0-rc.2

## Recent versions

- 0.1.0 (latest) — 2021-09-10

## README

# jupyverse-auth

![Github Actions Status](https://github.com/davidbrochart/jupyverse-auth/workflows/Build/badge.svg)

A JupyterLab extension for authentication.


This extension is composed of a Python package named `jupyverse-auth`
for the server extension and a NPM package named `jupyverse-auth`
for the frontend extension.


## Install

To install the extension, execute:

```bash
mamba create -n jupyverse-auth-dev
conda activate jupyverse-auth-dev
mamba install pip nodejs

pip install -e .
jupyter labextension develop . --overwrite
jlpm
jlpm run build
```

## Authentication with GitHub

You will need to authorize JupyterLab to access your GitHub information. You can register a new
OAuth application [here](https://github.com/settings/applications/new):
- Application name: JupyterLab
- Homepage URL: http://127.0.0.1:8000/lab
- Authorization callback URL: http://127.0.0.1:8000/auth/github/callback

`127.0.0.1` and `8000` are the IP and port number, respectively. You might have to change them
according to your particular setup.

This will generate a client ID for you, and you must also generate a client secret.

When launching jupyverse, you must pass the client ID and secret:

```bash
jupyverse --config=path/to/config.toml
```

Where `config.toml` looks like this:

```toml
[authenticator]
client_id = "your_client_id"
client_secret = "your_client_secret"
```

---
_Source: https://npm.io/package/jupyverse-auth · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._