Streamlit-Authenticator 使用教程

伍霜盼Ellen

于 2024-08-12 08:50:11 发布

阅读量423

点赞数 4

本文链接：https://blog.csdn.net/gitblog_00277/article/details/141120081

版权

Streamlit-Authenticator 使用教程

Streamlit-AuthenticatorA secure authentication module to validate user credentials in a Streamlit application.项目地址:https://gitcode.com/gh_mirrors/st/Streamlit-Authenticator

项目概述

Streamlit-Authenticator 是一个用于Streamlit应用程序的安全认证模块，由Mohammad Khorasani开发并维护。它允许开发者轻松地集成用户验证功能到他们的应用中，确保只有授权用户可以访问特定内容。

目录结构及介绍

Streamlit-Authenticator的项目结构简洁明了，包含了必要的源代码和配置文件。以下是关键的目录和文件：

streamlit_authenticator : 主要的源码目录，包含认证逻辑。
- 这里封装了处理用户身份验证的核心类和方法。
tests : 单元测试相关的文件夹，用于确保代码质量。
setup.py : 包含了安装此包所需的元数据和指令，用于发布到PyPI或本地安装。
LICENSE : 项目的MIT许可证文件，说明了软件使用的许可条款。
README.md : 项目的主要说明文件，包括简介、安装步骤以及快速入门指南。
config.yaml : 示例配置文件，展示了如何定义用户的用户名、密码等认证信息以及Cookie设置。

项目的启动文件介绍

在实际使用场景中，没有直接指定的“启动文件”，因为这通常是用户自己的Streamlit应用中的脚本。不过，为了使用Streamlit-Authenticator，你需要在你的Streamlit应用的主脚本中引入该库，并按需调用其API来实现认证功能。一个简单的示例是导入streamlit和streamlit_authenticator库，并通过提供的函数配置和验证用户。

假设你的启动文件名为 app.py:

import streamlit as st
import streamlit_authenticator as stauth

# 这里你应该根据config.yaml或其他方式设定你的用户信息
names = ['User1', 'User2']
usernames = ['user1', 'user2']
passwords = ['pass123', 'pass456']

hashed_passwords = stauth.Hasher(passwords).generate()

authenticator = stauth.Authenticate(names, usernames, hashed_passwords,
                                   'cookie_name', 'random_key', 30)

name, authentication_status, username = authenticator.login('Login', 'main')

if authentication_status == False:
    st.error('用户名/密码错误')
elif authentication_status == None:
    st.warning('请输入用户名和密码')
else:
    st.write(f'欢迎登录，{name}')

项目的配置文件介绍

config.yaml 文件是存储认证信息的关键。它的结构通常如下：

credentials:
  usernames:
    user1:
      name: User One
      password: $argon2id$v=19$m=10240,t=2,p=1$W1JrVUxkdE9QZzBTa3duS0k$VjY0cXpBQlJVRnJiMXFHaHJuUWRJbE9CTGtQSGdRQT0=
    user2:
      name: User Two
      password: $argon2id$v=19$m=10240,t=2,p=1$hU0yelJGRklQbDlWdk5UR0RBPT0$qXJvbEluQ0dITnhOQkxVSUtzenhWQVBSS2EyeFBuQTVmazh1VT0=
cookie:
  name: your_cookie_name
  key: "your_random_key"
  expiry_days: 30