Framework/Streamlit: Add basic example about Streamlit, reading sys.summits

Author: proddata

framework/streamlit/.streamlit/secrets.toml

@@ -0,0 +1,8 @@
+# .streamlit/secrets.toml
+
+[connections.cratedb]
+dialect = "crate"
+host = "localhost"
+port = "4200"
+username = "crate"
+password = ""

framework/streamlit/README.md

@@ -0,0 +1,34 @@
+# Streamlit with CrateDB Example
+
+## About
+Demonstrate connectivity from Streamlit to CrateDB.
+
+## Configuration
+Configure database connection address and credentials within
+`.streamlit/secrets.toml` in your working directory. Please
+make sure to use valid credentials matching your environment.
+
+## Usage
+To start a CrateDB instance on your machine, invoke:
+```shell
+docker run -it --rm \
+  --publish=4200:4200 --publish=5432:5432 \
+  --env=CRATE_HEAP_SIZE=2g \
+  crate:latest -Cdiscovery.type=single-node
+```
+
+Install dependencies.
+```shell
+pip install -r requirements.txt
+```
+
+Invoke Streamlit to serve the application.
+```shell
+streamlit run basic_sys_summits.py
+```
+
+## Screenshot
+
+Enjoy the list of mountains.
+
+![image](https://github.com/crate/cratedb-examples/assets/453543/7dc54224-06d0-4cfb-a5e0-b216c03bf3d2)

framework/streamlit/basic_sys_summits.py

@@ -0,0 +1,25 @@
+"""
+A basic Streamlit application connecting to CrateDB using SQLAlchemy.
+
+It reads the built-in `sys.summits` table into a dataframe, and
+displays its contents.
+
+- https://docs.streamlit.io/develop/tutorials/databases
+- https://cratedb.com/docs/sqlalchemy-cratedb/
+"""
+import streamlit as st
+
+# Set a title for the page.
+st.title("Streamlit with CrateDB Example")
+
+# Connect to CrateDB, and read the built-in `sys.summits` table.
+conn = st.connection("cratedb", type="sql")
+df = conn.query('SELECT * FROM "sys"."summits";', ttl="10m")
+
+# Output data as dataframe and table.
+st.dataframe(df)
+st.table(df)
+
+# Output data as Markdown.
+for row in df.itertuples():
+    st.write(f"{row.mountain}")

framework/streamlit/requirements.txt

@@ -0,0 +1,2 @@
+streamlit==1.*
+sqlalchemy-cratedb==0.38.0