Skip to main content

OAuthenticator: Authenticate JupyterHub users with common OAuth providers

Project description

OAuth + JupyterHub Authenticator = OAuthenticator :heart:

Documentation build status GitHub Workflow Status Latest PyPI version Latest conda-forge version GitHub Discourse Gitter

OAuth is a token based login mechanism that doesn't rely on a username and password mapping. In order to use this login mechanism with JupyerHub the login handlers need to be overridden. OAuthenticator overrides these handlers for the common OAuth2 identity providers allowing them to be plugged in and used with JupyterHub.

The following authentication services are supported through their own authenticator: Auth0, Azure AD, Bitbucket, CILogon, GitHub, GitLab, Globus, Google, MediaWiki, Okpy, OpenShift.

There is also a GenericAuthenticator that can be configured with any OAuth 2.0 identity provider or can be used to create a new authenticator class when additional customization is needed.

Installation

The installation guide can be found in the docs.

The docs also provide example setups for different OAuth2 identity providers:

Running tests

To run the tests locally:

$ pip install --upgrade --pre -r test-requirements.txt
$ pytest -v ./oauthenticator/tests/

Or you run a specific test file with:

$ pytest -v ./oauthenticator/tests/<test-file-name>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

oauthenticator-0.13.0.tar.gz (39.6 kB view details)

Uploaded Source

Built Distribution

oauthenticator-0.13.0-py3-none-any.whl (56.1 kB view details)

Uploaded Python 3

File details

Details for the file oauthenticator-0.13.0.tar.gz.

File metadata

  • Download URL: oauthenticator-0.13.0.tar.gz
  • Upload date:
  • Size: 39.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

File hashes

Hashes for oauthenticator-0.13.0.tar.gz
Algorithm Hash digest
SHA256 5202adcd96ddbbccbc267da02f2d14e977300c81291aaa77be4fd9f2e27cfa37
MD5 c5c9006e75f8d1eb66473d60f7ed290e
BLAKE2b-256 f89a2b316f61311ab05d2d5742dc3bcc90d1bf69e23e5c29833d9ee75e35b89e

See more details on using hashes here.

Provenance

File details

Details for the file oauthenticator-0.13.0-py3-none-any.whl.

File metadata

  • Download URL: oauthenticator-0.13.0-py3-none-any.whl
  • Upload date:
  • Size: 56.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

File hashes

Hashes for oauthenticator-0.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 114b25066abe97d3deead48b65b720d8e3a0d715f0924e7a29df06936ca5f06a
MD5 90ea70b8ac6762b9ca025cff69d76c05
BLAKE2b-256 0dd78da2671cb3c4aa29cb7f7dcb6df9311a2ff0f15fc87e79592455c2caad8b

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page