Skip to main content

Business Intelligence as Configuration

Project description

StreamLana

'Business Intelligence as Configuration' 🚀

Motivation

Think of Streamlit in Grafana style...

Build your BI dashboards with ease, using simple configuration files.

Demo App

Its deployed live at https://streamlana.streamlit.app/

Lets do this

  1. Install streamlana
pip install streamlana
  1. Define your pages in hello.yaml
#hello.yaml
side_bar:
  - heading: "Hello StreamLana"
    pages:
      - name: "Stats page"
        enabled: True
        config_file_path: "page_configs_demo/hello.json"
      - name: "About page"
        config_file_path:  "page_configs_demo/about.json"
        enabled: True
  1. Lets define page1 layout - number or rows, the widgets in each row, query powering the widget, widget settings.

Lets do 1 row with 2 widgets in it -> page_configs_demo/hello.json

{
    "page_title": "Hello StreamLana",
    "page_rows": [
        {
            "widgets_width_spec": [
                0.4,0.6
            ],
            "widgets_border": true,
            "with_expander": {
                "label": "2 widgets in 1st row, 40/60% width",
                "expanded": true
            },
            "widgets_gap": "small",
            "widgets_vertical_alignment": "top",
            "widgets": [
              {
                    "type": "dataframe",
                    "query": "SELECT avg_spend,order_date FROM (SELECT order_date, RANDOM() * 1000 AS avg_spend FROM generate_series(CURRENT_DATE - INTERVAL 30 DAY, CURRENT_DATE, INTERVAL 1 DAY) AS t(order_date)) as sub",
                    "config": {
                        "column_order": [
                            "avg_spend",
                            "order_date"
                        ]
                    }
                },
                {
                    "type": "line_chart",
                    "query": "SELECT avg_spend,order_date FROM (SELECT order_date, RANDOM() * 1000 AS avg_spend FROM generate_series(CURRENT_DATE - INTERVAL 30 DAY, CURRENT_DATE, INTERVAL 1 DAY) AS t(order_date)) as sub",
                    "config": {
                        "x": "order_date",
                        "y": ["avg_spend"],
                        "title": "avgSpend Over Time"
                    }
                }
            ]
        }
    ]
}
  1. Lets define page2 layout - number or rows, the widgets in each row, query powering the widget, widget settings.

Lets keep this simple 1 widget and 1 row -> page_configs_demo/about.json

{
    "page_title": "About StreamLana",
    "page_rows": [
        {
            "widgets_width_spec": [1],
            "widgets": [{"type": "title", "config": {"body": "Business Intelligence as Configuration"}}]
        }
    ]
}
  1. Few lines of code for the main app -> hello.py
# hello.py
import logging
import duckdb
from streamlana import side_bar_util
from streamlana.side_bar_util import load_side_bar_config_yaml, render_side_bar_pages

# ✅ First thing to do, set page layout of streamlit
side_bar_util.set_page_layout(layout="wide")

# logging level
logging.basicConfig(level=logging.INFO)

# ✅ Load side bar configuration from YAML file
side_bar_config = load_side_bar_config_yaml("hello.yaml")

# ✅ Create DuckDB connection (do your setup with it)
con = duckdb.connect()

# ✅ Render side bar pages based on the configuration
render_side_bar_pages(side_bar_config, con)
  1. Run the app
streamlit run hello.py

Widget Library

Currently, we support the following widgets:

  • st.dataframe
  • st.line_chart
  • st.area_chart
  • st.bar_chart
  • st.pie_chart
  • st.json
  • st.title
  • st.metric
  • st.text
  • st.markdown
  • st.image
  • st.map
  • st.empty
  • st.selectbox
  • st.header

Adding new widgets is easy, just add a new widget type in the chart_helpers.py.

ex: implement 'render_<chart_name>(data:pd.DataFrame, config_dict: dict)'

data comes from the duckdb sql query u configure.

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

streamlana-0.1.1.tar.gz (43.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

streamlana-0.1.1-py3-none-any.whl (42.3 kB view details)

Uploaded Python 3

File details

Details for the file streamlana-0.1.1.tar.gz.

File metadata

  • Download URL: streamlana-0.1.1.tar.gz
  • Upload date:
  • Size: 43.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.13 Darwin/24.5.0

File hashes

Hashes for streamlana-0.1.1.tar.gz
Algorithm Hash digest
SHA256 e651cb922b029e4e83e6939cb94fcc334911d147f4356146cd09a348bf282a6a
MD5 f235c219cc55d1da7ef3a8584ef20e98
BLAKE2b-256 249f4cf5603cf6aa08cf48c06fc6ba06e5d37752a815b0bcb32364f3c07834d1

See more details on using hashes here.

File details

Details for the file streamlana-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: streamlana-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 42.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.13 Darwin/24.5.0

File hashes

Hashes for streamlana-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6fbc34f7bb602897d3d960ff596a457371b84422b040155742efda500a474c6e
MD5 9e4dfee6e0ea3d88212fea068c733345
BLAKE2b-256 6f195bcff588363120fdd29121ad495d5de8460216577ba57cd2d6a3cc944d80

See more details on using hashes here.

Supported by

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