Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Dash live updates example (Live Bitcoin Tracker) #269

Merged
merged 19 commits into from
Aug 18, 2024

Conversation

ellieko
Copy link
Contributor

@ellieko ellieko commented Aug 14, 2024

Added a Real-time Live Bitcoin Tracker demo in examples/dash/dash-live-updates as an example of displaying real-time data in Dash

In the examples/dash/dash-live-updates directory:

For README:

  • README.md
  • dashboard.png

For REST API method (not used in the blog post or demo)

  • rest_api_dash.py (REST API method)

For WebSocket API method (used in the blog post and demo)

  • app.py (Dash app for WebSocket method)
  • websocket_backend.py (Data Fetching and Storage for WebSocket method)
  • requirements.txt (libraries needed for WebSocket method)

The detailed explanation is in the draft blog post. The dash app is deployed but stopped for now, because testing the demo locally would be only possible with a remote DB requirement. I can share my DB connection details via Slack if that's okay.


📚 Documentation preview 📚: https://ploomber-doc--269.org.readthedocs.build/en/269/

@ellieko ellieko changed the title Dash live updates Add Dash live updates example (Live Bitcoin Tracker) Aug 14, 2024
@ellieko
Copy link
Contributor Author

ellieko commented Aug 14, 2024

Recording of the deployed Dash app:

Screen.Recording.2024-08-13.at.10.21.50.PM.mov

@ellieko
Copy link
Contributor Author

ellieko commented Aug 16, 2024

Hi @neelasha23, @bryannho, this is also ready for review. Thanks a lot! :))

Edit: the dash app is deployed here although it's not useful cuz it doesn't show anything unless websocket_backend.py is being run on my local machine.

Copy link
Contributor

@bryannho bryannho left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ellieko I saw that rest_api_dash.py is included but isn't used. I think it could be useful to keep it in case users wanted to try that method. Can you add a note in the README.md explaining what the file is and that it isn't used? otherwise, lgtm

@ellieko
Copy link
Contributor Author

ellieko commented Aug 16, 2024

@ellieko I saw that rest_api_dash.py is included but isn't used. I think it could be useful to keep it in case users wanted to try that method. Can you add a note in the README.md explaining what the file is and that it isn't used? otherwise, lgtm

Good point, thanks! Added here

@edublancas edublancas merged commit c5b9d13 into main Aug 18, 2024
1 check passed
@edublancas edublancas deleted the dash-live-updates branch August 18, 2024 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants