Skip to main content

A simple synchronous way of accessing localStorage from your Streamlit app.

Project description

streamlit-ws-localstorage

Finally a simple synchronous way of accessing localStorage from your Streamlit app.

Downloads

Why

I tried using extra-streamlit-components but found it too complex, because of the way Streamlit components works. Since the communication between the browser and streamlit app is async, your app is run multiple times, and nested if else blocks may not work properly. A simple call to get all cookies causes the app to be run 4 times in total. And the first call to get all cookies returns an empty dictionary which needs to be handled in the code.

Looking at the complexity, I thought it would be easier to write a synchronous commmunication.

How to run

Using it is fairly simple:

import streamlit as st
from streamlit_ws_localstorage import injectWebsocketCode, getOrCreateUID

# Main call to the api, returns a communication object
conn = injectWebsocketCode(hostPort='linode.liquidco.in', uid=getOrCreateUID())

st.write('setting into localStorage')
ret = conn.setLocalStorageVal(key='k1', val='v1')
st.write('ret: ' + ret)

st.write('getting from localStorage')
ret = conn.getLocalStorageVal(key='k1')
st.write('ret: ' + ret)

You can use the linode.liquidco.in websocket relay server for testing. Alternately run your websocket relay server from the code in websocket-server/ws_server.py

Video demo

https://user-images.githubusercontent.com/544881/185042658-43dd3c58-a086-4457-a042-9d4d895e34ba.mp4

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_ws_localstorage-1.0.6.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

streamlit_ws_localstorage-1.0.6-py2-none-any.whl (19.8 kB view details)

Uploaded Python 2

File details

Details for the file streamlit_ws_localstorage-1.0.6.tar.gz.

File metadata

File hashes

Hashes for streamlit_ws_localstorage-1.0.6.tar.gz
Algorithm Hash digest
SHA256 76606d13628522838386a73755c9a4da5475da72ea0ca6cf83e2ab482e152dad
MD5 9808116bde628c203665ebef8dd068aa
BLAKE2b-256 b417c7eacd4aa35be20b6897d387c7a30a2ba96ae9afe6ba3fa8ad9842dfd7e5

See more details on using hashes here.

File details

Details for the file streamlit_ws_localstorage-1.0.6-py2-none-any.whl.

File metadata

File hashes

Hashes for streamlit_ws_localstorage-1.0.6-py2-none-any.whl
Algorithm Hash digest
SHA256 9f7719b9278e0009a9e0cf564fdc7a2752bc76485abf52b7cdbf35da339ae2c7
MD5 056f1a0f7e58568272d3ba9391e7a830
BLAKE2b-256 5368be51032a3048d2b3b6be59b2833695b64401c782c55e89a65903950cd316

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