Skip to main content

Simple OAuth2 authorization code flow for Streamlit

Project description

🔐 Streamlit OAuth: Enhance Your Data Apps with Seamless Integration

Effortlessly integrate OAuth2 authorization into your Streamlit apps using the streamlined httpx_oauth wrapper

Why Streamlit OAuth?

In today's digital landscape, authorization is crucial for accessing and utilizing data from various applications. With Streamlit OAuth, you can easily incorporate OAuth2 authorization into your Streamlit data apps, allowing you to securely and efficiently fetch data from other applications. This powerful integration unlocks the full potential of your Streamlit data-driven applications, enabling you to create more dynamic and interactive user experiences.

Installation

pip install streamlit-oauth

Getting started

To use Streamlit OAuth, you need to create an OAuth2 component with your authentication details (set your callback url to https://<YOUR ADDRESS>/component/streamlit_oauth.authorize_button):

import streamlit as st
from streamlit_oauth import OAuth2Component
import os

# Load environment variables from .env file
from dotenv import load_dotenv
load_dotenv()

# Set environment variables
AUTHORIZE_URL = os.environ.get('AUTHORIZE_URL')
TOKEN_URL = os.environ.get('TOKEN_URL')
REFRESH_TOKEN_URL = os.environ.get('REFRESH_TOKEN_URL')
REVOKE_TOKEN_URL = os.environ.get('REVOKE_TOKEN_URL')
CLIENT_ID = os.environ.get('CLIENT_ID')
CLIENT_SECRET = os.environ.get('CLIENT_SECRET')
REDIRECT_URI = os.environ.get('REDIRECT_URI')
SCOPE = os.environ.get('SCOPE')

# Create OAuth2Component instance
oauth2 = OAuth2Component(CLIENT_ID, CLIENT_SECRET, AUTHORIZE_URL, TOKEN_URL, REFRESH_TOKEN_URL, REVOKE_TOKEN_URL)

# Check if token exists in session state
if 'token' not in st.session_state:
    # If not, show authorize button
    result = oauth2.authorize_button("Authorize", REDIRECT_URI, SCOPE)
    if result and 'token' in result:
        # If authorization successful, save token in session state
        st.session_state.token = result.get('token')
        st.rerun()
else:
    # If token exists in session state, show the token
    token = st.session_state['token']
    st.json(token)
    if st.button("Refresh Token"):
        # If refresh token button is clicked, refresh the token
        token = oauth2.refresh_token(token)
        st.session_state.token = token
        st.rerun()

more examples can be found in the examples

Parameters:

  • client_id: The OAuth2 client id provided by the authorization server.
  • client_secret: The OAuth2 client secret provided by the authorization server.
  • authroize_endpoint: The authorization endpoint URL of the OAuth2 server. (Deprecated for typo.)
  • authorize_endpoint: The authorization endpoint URL of the OAuth2 server.
  • token_endpoint: The token endpoint URL of the OAuth2 server.
  • refresh_token_endpoint: The refresh token endpoint URL of the OAuth2 server.
  • revoke_token_endpoint: The revoke token endpoint URL of the OAuth2 server.
  • client: The httpx_oauth client to be used for the requests, default is None, if specified other arguments will be ignored.

authorize_button(self, name, redirect_uri, scope, height=800, width=600, key=None, extra_params={}, pkce=None, use_container_width=False, icon=None)

Generates an HTML button that initiates the OAuth2 authorization code grant flow. The button opens a popup window that prompts the user to authorize the application.

Parameters:

  • name: The name to be displayed on the button.
  • redirect_uri: The URL where the authorization server will redirect the user after the authorization process is completed.
  • scope: The OAuth2 scopes required by the application.
  • height: The height of the popup window.
  • width: The width of the popup window.
  • key: The unique key of the button component.
  • extra_params: A dictionary containing extra parameters to be sent to the authorization server.
  • pkce: accept value S256 indicating whether to use PKCE (Proof Key for Code Exchange) for the authorization code grant flow.
  • use_container_width: If True, set the button width to the container width.
  • icon: The icon to be displayed on the button.
  • auto_click: If True, the button will be clicked automatically.

Returns:

  • A dictionary containing the authorization code or access token object, depending on the flow.

refresh_token(self, token, force=False)

Refreshes the access token using the refresh token. If the token is not expired, the function returns the same token.

Parameters:

  • token: The access token object to be refreshed.
  • force: A boolean value that forces the refresh token to be used, even if the access token is not expired.

Returns:

  • A dictionary containing the new access token or the same access token if it has not expired.

revoke_token(self, token, token_type_hint='access_token')

Parameters:

  • token: The access token object to be revoked.
  • token_type_hint: A hint about the type of the token submitted for revocation.

Returns:

  • A boolean value indicating whether the token was revoked successfully.

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

streamlit_oauth-0.1.14.tar.gz (65.4 kB view details)

Uploaded Source

Built Distribution

streamlit_oauth-0.1.14-py3-none-any.whl (121.0 kB view details)

Uploaded Python 3

File details

Details for the file streamlit_oauth-0.1.14.tar.gz.

File metadata

  • Download URL: streamlit_oauth-0.1.14.tar.gz
  • Upload date:
  • Size: 65.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for streamlit_oauth-0.1.14.tar.gz
Algorithm Hash digest
SHA256 bb54c6cb489e02fa389c6727e668b363e2da9ba73d19da221c865d2e83250453
MD5 f06a17d93c64b784e246a6452bf6c76e
BLAKE2b-256 90c605fc0f5ce56253a7ac4ece6bc146921b8b95a65f19653ad1005954f41539

See more details on using hashes here.

File details

Details for the file streamlit_oauth-0.1.14-py3-none-any.whl.

File metadata

File hashes

Hashes for streamlit_oauth-0.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 d7b6608df8c2bedaa32a7602c983dbefa0316103e77dfdfc3aa7a84d932af898
MD5 2c48f0ab087d044367b8417249f9b5ee
BLAKE2b-256 088dd70b107f7b092d760ebcebc2fbeebe3c35480403bae1537c595120120a0e

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