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, FeiShu, 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-plus-15.1.3.tar.gz (49.7 kB view details)

Uploaded Source

Built Distribution

oauthenticator_plus-15.1.3-py3-none-any.whl (66.3 kB view details)

Uploaded Python 3

File details

Details for the file oauthenticator-plus-15.1.3.tar.gz.

File metadata

  • Download URL: oauthenticator-plus-15.1.3.tar.gz
  • Upload date:
  • Size: 49.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/57.4.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.7

File hashes

Hashes for oauthenticator-plus-15.1.3.tar.gz
Algorithm Hash digest
SHA256 f39c06c0517449aa70cb05fe205cd782c69ee5a7af08da9acb15a117e8a1ed4e
MD5 595127b28a9e59225ac44067099dc4a6
BLAKE2b-256 df52576acd10d106930ffe07f0ee4b974cbf08ac63623d2c3649bbdac32a3be7

See more details on using hashes here.

File details

Details for the file oauthenticator_plus-15.1.3-py3-none-any.whl.

File metadata

  • Download URL: oauthenticator_plus-15.1.3-py3-none-any.whl
  • Upload date:
  • Size: 66.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/57.4.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.7

File hashes

Hashes for oauthenticator_plus-15.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9fa80a6aef20fbc9e977022c7dda6af83f56dd94af18a48a4531f5815c4263bf
MD5 7a86a8b9bb5b77896e07edb9e1d6316f
BLAKE2b-256 54078f4fa7b7dce208ae7f5b8c4200db90301aa74354d90b2162413bf7239315

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