A streamlit companion library to create a interactive reader for the content on a given folder.
Project description
streamlit_book
streamlit_book
is a streamlit companion library, written in python+streamlit to create a interactive reader for the content on a given folder. It was developed on November 2021 during streamlit's hackathon - ended up being awarded one of the two best apps!
Documentation
All the documentation is at readthedocs.
Demos
The list of all demos of the library for release 0.7.0. are:
- Demo Methods: differente activities and methods.
- Demo Multipaging: Different multipaging options (native and stbook).
Examples
Some apps using the library are:
- Happy Birds : A self contained example that mixes features of the library with a funny twist.
- The (confusion) Matrix: Take the blue pill to learn all about the confusion matrix.
- The Streamlitsaurus Rex: Will teach you to always visualize your data, and exhibits the mythical Datasaurus.
How to use it
Install it:
pip install streamlit_book
There are different ways to use it, but in short just add to streamlit_app.py
the function that list the files to be read (and other properties):
import streamlit as st
import streamlit_book as stb
# Streamlit page properties
st.set_page_config()
# Streamit book properties
stb.set_book_config(menu_title="streamlit_book",
menu_icon="lightbulb",
options=[
"What's new on v0.7.0?",
"Core Features",
],
paths=[
"pages/00_whats_new.py", # single file
"pages/01 Multitest", # a folder
],
icons=[
"code",
"robot",
],
save_answers=True,
)
Star History
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 Distributions
Built Distribution
File details
Details for the file streamlit_book-0.7.6-py3-none-any.whl
.
File metadata
- Download URL: streamlit_book-0.7.6-py3-none-any.whl
- Upload date:
- Size: 28.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | dda6a2e7dde5a5c8ef14327933abe7398f7a20c184b98460bfa5020d847dd802 |
|
MD5 | 142973660c1905c3f896d6474a3987a7 |
|
BLAKE2b-256 | 758962e252995cbef4d40068f6e2967f41bc9cb6c5f23b0b8ecd8bd3c28101e3 |