README.md

streamlit-auth

Streamlit module for creating oauth protected Stramlit apps.

Packaging

为了将此模块打包并上传到PyPI，请遵循以下步骤：

python3 -m pip install build
python3 -m build
python3 -m pip install --user --upgrade twine
python3 -m twine upload --repository pypi dist/*

Local Installation

要在本地安装此模块，可以使用以下命令：

pip install dist/*.tar.gz

streamlit-auth

A python package for creating oauth protected Stramlit apps!

Documentation

Once you configure the authentication and subscription on st.secrets, you can use the the library methods to conditionally render the content of the page:

import streamlit as st
from streamlit_auth import add_auth

add_auth()

st.write("Congrats, you are logged in!")
st.write('the email of the user is ' + str(st.session_state.login_user["email"]))

This package expects that you have a .streamlit/secrets.toml file which you will have to create. Inside it, you will need to add your Keycloak or Google API information that runs the authentication. Below is how the package expects your secrets file to look.

[oauth]
provider = "keycloak"

[oauth.google]
client_id = "....apps.googleusercontent.com"
client_secret = "GOCSPX-..."
redirect_url_test = 'http://localhost:8501/'
redirect_url = "http://localhost:8501/"

[oauth.keycloak]
url = 'https://keycloak.your-domain.com/auth'
realm = 'myrealm'
client_id = 'myclient'
logout_url = "https://keycloak.your-domain.com/auth/realms/myrealm/protocol/openid-connect/logout"