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, 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.2.1.tar.gz (56.8 kB view details)

Uploaded Source

Built Distribution

oauthenticator-16.2.1-py3-none-any.whl (75.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for oauthenticator-16.2.1.tar.gz
Algorithm Hash digest
SHA256 a89aeb7aad86849c6b5fd91e64e615ce38a1b34442ca669df8c184ad6e5e70f7
MD5 68bc65449ae2a343e83313b819bfc086
BLAKE2b-256 601cff116ea478279983a2ddc8196a020983d6c778c07d863dc169b0a771a7b5

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for oauthenticator-16.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a23920c6a8350d3218dc9fff5f7a60401e9be5abbbf48722c16c56bb217b0208
MD5 ec1ce0b67298e4b47c7f91eaf030e356
BLAKE2b-256 af74376cf01e0b17be65940225337d24aa9953194f3e9155f1fc3e373941147f

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