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

Uploaded Source

Built Distribution

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

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

Uploaded Python 2

File details

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

File metadata

File hashes

Hashes for streamlit_ws_localstorage-1.0.5.tar.gz
Algorithm Hash digest
SHA256 14cf8d1e14c3dac92550d0c990684d0a85b2b69a65987b643a921ccef77d10b6
MD5 949f5cf9c4de95beb1fc8810164a6891
BLAKE2b-256 b98bb48f3b25865c7afd701aa58657b5d0953130d2552957d9171818a66ea4c4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for streamlit_ws_localstorage-1.0.5-py2-none-any.whl
Algorithm Hash digest
SHA256 1596b263952808bb8852070abcd08d430147586657ea5c14095072cc54a2bf42
MD5 cbda1325b415380ebb3e186279b0d0e6
BLAKE2b-256 d4e30c22704e2689352583cbec8669d09b27ec0f64cbadc2becbc5d6b5d3cd61

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