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

Uploaded Source

Built Distribution

oauthenticator-16.0.7-py3-none-any.whl (74.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oauthenticator-16.0.7.tar.gz
  • Upload date:
  • Size: 54.3 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.7.tar.gz
Algorithm Hash digest
SHA256 a2917b1dd4c95f833b813801d15c96cb21bf0ceee5ad54ef4dcc4c057ddae941
MD5 f4718efd3fdd4dff8c6062f9b6982e72
BLAKE2b-256 7cec91ee9f70a4d7c87bb7d1d30de67aa264579bbf1b4d8b218d670723d67032

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for oauthenticator-16.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 8645963b84939494139fe71954f00077c135a3170df0fc37d978c714956756f1
MD5 68f11c1ab8c65134f93689137d6f088b
BLAKE2b-256 5ff4c32f1e0d707a1873b915ac5f69990e6208514db220465159aad4737b63aa

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