Streamlit Login Auth UI 安装和配置指南

Streamlit Login Auth UI 安装和配置指南

streamlit_login_auth_ui It lets you connect your streamlit application to a pre-built and secure Login/ Sign-Up page. 项目地址: https://gitcode.com/gh_mirrors/st/streamlit_login_auth_ui

1. 项目基础介绍和主要编程语言

项目介绍

streamlit_login_auth_ui 是一个为 Streamlit 应用程序开发者设计的开源库，旨在为 Streamlit 应用程序提供一个预构建且安全的登录/注册页面。该库允许用户重置密码，并支持通过加密的 cookies 自动认证用户，而无需每次都输入密码。用户可以通过“忘记密码”功能触发包含临时密码的电子邮件，并在验证后重置密码。

主要编程语言

该项目主要使用 Python 语言进行开发。

2. 项目使用的关键技术和框架

关键技术

• Streamlit: 一个用于快速构建数据应用程序的 Python 库。
• Cookies: 用于在用户浏览器中存储加密的认证信息。
• Lottie 动画: 用于在登录页面中添加动画效果。

框架

• Streamlit: 作为主要的前端框架，用于构建用户界面。
• Courier API: 用于发送密码重置邮件。

3. 项目安装和配置的准备工作和详细安装步骤

准备工作

在开始安装之前，请确保您的系统上已经安装了以下软件：

• Python 3.6 或更高版本
• pip（Python 包管理工具）

安装步骤

步骤 1: 创建虚拟环境（可选但推荐）

为了隔离项目的依赖环境，建议创建一个虚拟环境。

python3 -m venv venv
source venv/bin/activate  # 在 Windows 上使用 `venv\Scripts\activate`

步骤 2: 安装项目依赖

使用 pip 安装 streamlit_login_auth_ui 库及其依赖项。

pip install streamlit-login-auth-ui

步骤 3: 配置项目

在您的 Streamlit 应用程序中导入并配置 streamlit_login_auth_ui 库。

import streamlit as st
from streamlit_login_auth_ui.widgets import __login__

# 创建登录对象并配置参数
__login__obj = __login__(
    auth_token="your_courier_auth_token",  # 从 Courier API 获取的授权令牌
    company_name="Your Company Name",  # 公司或组织的名称
    width=200,  # 登录页面动画的宽度
    height=250,  # 登录页面动画的高度
    logout_button_name='Logout',  # 注销按钮的名称
    hide_menu_bool=False,  # 是否隐藏 Streamlit 菜单
    hide_footer_bool=False,  # 是否隐藏 Streamlit 页脚
    lottie_url="https://assets2.lottiefiles.com/packages/lf20_jcikwtux.json"  # 登录页面的 Lottie 动画 URL
)

# 构建登录界面
LOGGED_IN = __login__obj.build_login_ui()

# 只有在用户成功登录后才运行应用程序
if LOGGED_IN:
    st.markdown("您的 Streamlit 应用程序从这里开始。")

步骤 4: 运行应用程序

确保您的 Streamlit 应用程序已经配置好，并运行它。

streamlit run your_app_name.py

注意事项

• 确保您已经从 Courier API 获取了 auth_token，并将其正确配置在代码中。
• 如果您希望自定义登录页面的动画，可以从 LottieFiles 网站选择并获取动画的 URL。

通过以上步骤，您应该能够成功安装并配置 streamlit_login_auth_ui 库，为您的 Streamlit 应用程序添加一个安全的登录/注册页面。

streamlit_login_auth_ui It lets you connect your streamlit application to a pre-built and secure Login/ Sign-Up page. 项目地址: https://gitcode.com/gh_mirrors/st/streamlit_login_auth_ui