Skip to main content

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:

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

Star History Chart

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

streamlit_book-0.7.6-py3-none-any.whl (28.5 kB view details)

Uploaded Python 3

File details

Details for the file streamlit_book-0.7.6-py3-none-any.whl.

File metadata

File hashes

Hashes for streamlit_book-0.7.6-py3-none-any.whl
Algorithm Hash digest
SHA256 dda6a2e7dde5a5c8ef14327933abe7398f7a20c184b98460bfa5020d847dd802
MD5 142973660c1905c3f896d6474a3987a7
BLAKE2b-256 758962e252995cbef4d40068f6e2967f41bc9cb6c5f23b0b8ecd8bd3c28101e3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page