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 - Test 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, first setup a development environment as described in CONTRIBUTING.md, and then do:

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

Uploaded Source

Built Distribution

oauthenticator-16.0.4-py3-none-any.whl (73.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oauthenticator-16.0.4.tar.gz
  • Upload date:
  • Size: 53.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for oauthenticator-16.0.4.tar.gz
Algorithm Hash digest
SHA256 e9d66df8621b98e802f91e4a9457395b68e93dac429fe1a436456147fe1391ef
MD5 0ebf1664b01af87fb6a50a5b01e3d293
BLAKE2b-256 a76d1e07c612e0c21d15c1168657200e42f23113666719df7ce2e553455d3584

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for oauthenticator-16.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9a10f1990252ea395e62e0f3766637d05fcc8661e1e89b772dfa1d6040fe0b1b
MD5 2645d27011193f24888448b18c807278
BLAKE2b-256 3c890d7f3ebbee6cf993fc9ca8a09e878dd55daeaf2bd6f1ae993019d2f83863

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