renaudln / dash_socketio

dash socketio

Client Socket.IO for Dash

Install

pip install dash_socketio

Development

Getting Started

1. Create a new python environment:

   python -m venv venv
   . venv/bin/activate

   Note: venv\Scripts\activate for windows

2. Install python dependencies:

   pip install -r requirements.txt

3. Install npm packages:

   1. Optional: use nvm to manage node version:

      nvm install
      nvm use

   2. Install:

      npm install

4. Build:

   npm run build

Component Code

Publish

If publish on npm:

npm build
npm publish

Justfile

Alternatively, use the provided just commands:

1. Create a Python environment from previous step 1 and install:

   just install

2. Build

   just build

3. Publish

   just publish

4. See all commands with just -l

dash_socketio's Issues

ReadMe

Hi RenaudLN,

Thank you for your help the other day in the Plotly Forum.

I updated the ReadMe and added examples, the code from jinnyzor and one more case which I used.
It is my first time committing to someone's project like this. Should I push the Branch or make a Fork? What does the process usually look like?

Also, do you have any ideas in which direction you would like to develop this package further?
I saw the dash devices package and used your DashSocketIO to link components. Maybe something like the callback_shared might be an interesting addition, or do you rather keep it like it is?

Linking Components

One feature I want to use your library for is linking components across browser windows.

We have several pages with the same dropdown filters and we want to link them. The user can make selections and directly compare the result of this selection in a different view/dashboard.
I tried it with broadcast and that worked really well. But it would be sent to all users.

One option to solve it would be rooms. But I would need to ensure that the socket joins the room on start. Dash_devices achieved something similar with:

@app.callback_shared(None, [Input('shared_slider_no_output', 'value')])
def func(value):
    print('Shared slider no output', value)

I think this would basically wrap two steps:

1. The socket joins a specific room for sharing the input
2. Trigger the sent to socket on value change
3. Have the client-side callback update the state of the value