A streamlit file browser
Project description
Streamlit file browser
A streamlit component serve as web file browser from local directory.
Install
pip install st-file-browser
Usage Example
import streamlit as st
from streamlit_file_browser import st_file_browser
st.header('Default Options')
event = st_file_browser("example_artifacts", key='A')
st.write(event)
st.header('With Artifacts Server, Allow choose file, disable download')
event = st_file_browser("example_artifacts", artifacts_site="http://localhost:1024", show_choose_file=True, show_download_file=False, key='B')
st.write(event)
st.header('Show only molecule files')
event = st_file_browser("example_artifacts", artifacts_site="http://localhost:1024", show_choose_file=True, show_download_file=False, glob_patterns=('molecule/*',), key='C')
st.write(event)
API
name | usage | type | required | default |
---|---|---|---|---|
key | react key | string | No. But I suggest giving each component a different key | None |
path | the path of dir | strubg | Yes | |
glob_patterns | To control file shows, the usage is the same as the patterns of glob.glob | string (regex) | No | '**/*' |
ignore_file_select_event | If ignore the 'file_selected' event | bool | No | False |
extentions | Only show the files included in the extentions | list | No | None |
show_delete_file | If show the button of delete file | bool | No | False |
show_choose_file | If show the button of choose file | bool | No | False |
show_new_folder | If show the button of new folder | bool | No | False |
show_upload_file | If show the button of upload file | bool | No | False |
limit | File number limit | int | No | 10000 |
use_cache | If cache file tree | bool | No | False |
Run example
Build
If any changes were made to the frontend, go to st_file_browser/frontend
and run npm run build
(npm install --legacy-peer-deps
if you don't have the packages on your machine). Then push the changes made to the frontend/build
folder to the repo.
You may need to follow this help if you run into issues while building.
Now all you have to do is make a release and the github action will push to PyPi (make sure setup.py
has a new verison)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
st-file-browser-0.1.1.tar.gz
(1.3 MB
view hashes)
Built Distribution
Close
Hashes for st_file_browser-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f44b2c889123e210fdbda4103acc28770617ae1522ce7563b67550544b85d395 |
|
MD5 | 5f94db8c70a6a25c9f660abf60efee51 |
|
BLAKE2b-256 | 0eb161aebb087078ad746f007d82347f27859b61e2f0daef66d77202d0fa182d |