Skip to main content

Modern frontend web components based on Buefy for Streamlit.

Project description

Streamfy — Buefy for Streamlit

Modern frontend web components based on Bulma and Buefy for Streamlit.

Live demo at streamfy.streamlit.app

Getting Started

Install streamfy:

pip install streamfy

Create a simple application app.py:

import streamlit as st
import streamfy as sy

sy.carousel(items=[
  "https://picsum.photos/id/1051/1230/500",
  "https://picsum.photos/id/1052/1230/500",
  "https://picsum.photos/id/1053/1230/500",
])

Run this application:

streamlit run app.py

A file with all components is available in examples/all.py:

Take a look at Buefy's documentation for a list of all properties and examples available.

Contributing

Ensure you have Python 3.6+, Node.js, and npm installed.

Clone this repo and create a new Python virtual environment:

$ python3 -m venv venv  # create venv
$ . venv/bin/activate   # activate venv
$ pip install streamlit # install streamlit

Initialize and run the component frontend:

$ cd streamfy/frontend
$ npm install    # Install npm dependencies
$ npm run serve  # Start the Webpack dev server

From a separate terminal, run the Streamlit app:

$ . venv/bin/activate  # activate the venv you created earlier
$ streamlit run streamfy/__init__.py  # run the example

If all goes well, you should see something like this:

Modify the frontend code at streamfy/frontend/src/Streamfy.vue and the Python code at streamfy/__init__.py.

Resources

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

streamfy-0.3.5.tar.gz (812.9 kB view hashes)

Uploaded Source

Built Distribution

streamfy-0.3.5-py3-none-any.whl (820.8 kB view hashes)

Uploaded Python 3

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