Skip to main content

OAuthenticator: Authenticate JupyterHub users with common OAuth providers

Project description

OAuth + JupyterHub Authenticator = OAuthenticator :heart:

Documentation build status TravisCI (.org) build 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.0.tar.gz (26.6 kB view details)

Uploaded Source

Built Distribution

oauthenticator-0.12.0-py3-none-any.whl (36.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oauthenticator-0.12.0.tar.gz
  • Upload date:
  • Size: 26.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.7.1

File hashes

Hashes for oauthenticator-0.12.0.tar.gz
Algorithm Hash digest
SHA256 0bc5a4a0ee22689a863090993e0054485030847d0e9884afa1592ca388cccf4a
MD5 753d7d55476af57446fc7141f3c82bf1
BLAKE2b-256 277e93f872dec4e0c927c1352e6a8f084ed057c73c6b505c47cf79c53cd113d2

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: oauthenticator-0.12.0-py3-none-any.whl
  • Upload date:
  • Size: 36.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.7.1

File hashes

Hashes for oauthenticator-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bfa1014d0881c22c22500be44f3a5ce11abc0c9fd4107eb3382e4d7ba0eb5bdd
MD5 721fdc84fded615fcdf5f48dcaa8fb90
BLAKE2b-256 cacc52882c604b95a35c18015bf19483e9534d7ca6edefca335becf71bd7549f

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