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 Distribution

streamlit_slides-0.7.8.tar.gz (21.6 kB view details)

Uploaded Source

File details

Details for the file streamlit_slides-0.7.8.tar.gz.

File metadata

  • Download URL: streamlit_slides-0.7.8.tar.gz
  • Upload date:
  • Size: 21.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.1

File hashes

Hashes for streamlit_slides-0.7.8.tar.gz
Algorithm Hash digest
SHA256 077679a3be89d3c0fad9b6f29edc1669c27d60fe5caa6f26a088b6374ce3a37a
MD5 ec641808530e6b05b4b3c1ad73d24c41
BLAKE2b-256 1347066bf8607bd12c3dccdaa1805e0365b99e24fa7269fea00549384ba766b1

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