Streamlit-Keyup 项目使用教程

Streamlit-Keyup 项目使用教程

streamlit-keyup Streamlit text input that returns value on keyup 项目地址: https://gitcode.com/gh_mirrors/st/streamlit-keyup

1. 项目的目录结构及介绍

streamlit-keyup/
├── .github/
│   └── workflows/
├── src/
│   └── st_keyup/
├── flake8
├── .gitignore
├── pre-commit-config.yaml
├── LICENSE
├── MANIFEST.in
├── README.md
├── pyproject.toml
├── requirements.txt
├── setup.py
└── streamlit_app.py

目录结构介绍

• .github/workflows: 存放GitHub Actions的工作流配置文件。
• src/st_keyup: 项目的核心代码文件夹，包含主要的Python代码。
• flake8: 代码风格检查工具的配置文件。
• .gitignore: Git忽略文件配置。
• pre-commit-config.yaml: 预提交钩子的配置文件。
• LICENSE: 项目的开源许可证文件。
• MANIFEST.in: 用于指定在打包时需要包含的非Python文件。
• README.md: 项目的介绍和使用说明。
• pyproject.toml: 项目的构建系统配置文件。
• requirements.txt: 项目依赖的Python包列表。
• setup.py: 项目的安装脚本。
• streamlit_app.py: 项目的启动文件。

2. 项目的启动文件介绍

streamlit_app.py

这是项目的启动文件，负责运行Streamlit应用程序。以下是文件的主要内容：

import streamlit as st
from st_keyup import st_keyup

value = st_keyup("Enter a value", key="0")
st.write(value)

# 设置默认值
with_default = st_keyup("Enter a value", value="Example", key="1")

# 设置更新延迟
with_debounce = st_keyup("Enter a value", debounce=500, key="2")

功能介绍

• st_keyup: 这是一个自定义的Streamlit组件，用于在用户输入时实时获取输入值。
• st.write: 用于在Streamlit应用中显示内容。

3. 项目的配置文件介绍

pyproject.toml

这是项目的构建系统配置文件，定义了项目的构建工具和依赖项。以下是文件的主要内容：

[build-system]
requires = ["setuptools>=42", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "streamlit-keyup"
version = "0.1.0"
description = "Streamlit text input that returns value on keyup"
authors = [
    { name="Zachary Blackwood", email="zachary@streamlit.io" }
]
dependencies = [
    "streamlit>=0.82.0"
]

功能介绍

• build-system: 定义了构建系统的要求和后端。
• project: 定义了项目的名称、版本、描述、作者和依赖项。

requirements.txt

这是项目的依赖项列表，列出了项目运行所需的Python包。以下是文件的主要内容：

streamlit>=0.82.0

功能介绍

• streamlit: 项目依赖的Streamlit库，用于构建Web应用程序。

通过以上介绍，您可以更好地理解和使用streamlit-keyup项目。

streamlit-keyup Streamlit text input that returns value on keyup 项目地址: https://gitcode.com/gh_mirrors/st/streamlit-keyup