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.12.2.tar.gz (27.7 kB view details)

Uploaded Source

Built Distribution

oauthenticator-0.12.2-py3-none-any.whl (36.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oauthenticator-0.12.2.tar.gz
  • Upload date:
  • Size: 27.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.6

File hashes

Hashes for oauthenticator-0.12.2.tar.gz
Algorithm Hash digest
SHA256 a4e8d8c528b0386340fc59ba98118a2aeb668a3741288b7ac15fd35124a91813
MD5 c10d0c9f775535fa02edcfb613652fb8
BLAKE2b-256 3f26bb4c621cb0ea4dcf5df30f14249224ea26c1bcc73a9d1cb49d79015a75f4

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: oauthenticator-0.12.2-py3-none-any.whl
  • Upload date:
  • Size: 36.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.6

File hashes

Hashes for oauthenticator-0.12.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a4104f0f9222bbdfab77b13d9de37852ad0f42998e7cf267b2a4c8306d2d220a
MD5 8e1facfd7bbb494d7fe58501106dfcc4
BLAKE2b-256 015fae2f8d92f86dded7722bca783e9dd70240c9a6d5b73476e96528b5f15a32

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