Skip to main content

A Python package for creating oauth protected Streamlit apps

Project description

streamlit-auth

Streamlit module for creating oauth protected Stramlit apps.

Packaging

Releases

Streamlit App

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"

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

Uploaded Source

Built Distribution

streamlit_auth-0.1.7.1-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file streamlit-auth-0.1.7.1.tar.gz.

File metadata

  • Download URL: streamlit-auth-0.1.7.1.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for streamlit-auth-0.1.7.1.tar.gz
Algorithm Hash digest
SHA256 b5d7885a8fec105f53723301f43cbaedac9ea0ab0e41ae404b79f2f255473c55
MD5 ce6d1ff7f7a11c6af8314c21ab533a5a
BLAKE2b-256 792f3bb20de7a1ac71dada984a86bf9fe056e27291151a5b6770ee6b0a895ab3

See more details on using hashes here.

File details

Details for the file streamlit_auth-0.1.7.1-py3-none-any.whl.

File metadata

File hashes

Hashes for streamlit_auth-0.1.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1693627e86c871ba82a5dddc21570d31840c0049e6540ed3d930183d5492b25b
MD5 539fbddc791813e74dea038aeee39251
BLAKE2b-256 6e5c4a1da18fcaef0d055ecd28e2bab6eeb0a4faf425a8ee1bbbffe479658c82

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page