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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: oauthenticator-0.12.1.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.52.0 CPython/3.8.6

File hashes

Hashes for oauthenticator-0.12.1.tar.gz
Algorithm Hash digest
SHA256 f4a048e329766a6023768c9fefd77c859a9726bdf2029c62ec78de410ec876cd
MD5 13b363c38c1712605d1746aac946cc0f
BLAKE2b-256 4537cf6bdc30d450d3e5ac645c86912a1a6c808766cfee90021e5bb114878840

See more details on using hashes here.

File details

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

File metadata

  • Download URL: oauthenticator-0.12.1-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.52.0 CPython/3.8.6

File hashes

Hashes for oauthenticator-0.12.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c909f072c6720fba560f8a1dd7a70ff578d9165e846135f57efbfb2dd168f58e
MD5 9cfa9470a1087ec5a4cf5054af15ea64
BLAKE2b-256 a04b8142655fa48b76e2ef98ecfa54faacd438d692af5fb4a00e44929fec4a50

See more details on using hashes here.

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