search

ryansurf / cli-surf

Get surf and ocean data from the command line interface
MIT License
18 stars 31 forks source link

Draft Streamlit #43

Closed K-dash closed 4 months ago

K-dash commented 6 months ago

@ryansurf

https://github.com/ryansurf/cli-surf/issues/35#issuecomment-2144156493

This is regarding the Streamlit discussion above. (This is Draft PR.)

To make it easy to try out Streamlit's features, we have implemented some basic functionality. Check out this branch and execute the following commands to start the server.

poetry install
poetry shell
streamlit run src/dev_streamlit.py

Then, access http://localhost:8501.

For example, if you want to display sea data in a graph, you would pass the response from an API that provides ocean data(Data now retrieved by cli.py) to the Streamlit code.

There are many other things you can do with Streamlit, so check out the official documentation for more information :)

I would love to help you with the front end implementation, but I don't know what you want to show your users, Let's just leave it at that for now, in terms of your help (lol).

ryansurf commented 6 months ago

I think this might be perfect for our use case.

I think it would be cool to show users a graph of the forecasted surf heights. The forecast goes up to a week, so we can use a line graph to plot this, perhaps along with the swell period.

Eventually, I want to also gather ocean temperature and tides. These would also work well on some sort of chart/graph.

This looks great. I'm gonna mess around with the code now and see what I can come up with

K-dash commented 4 months ago

Since the Streamlit matter is progressing in https://github.com/ryansurf/cli-surf/pull/44, I'll close this Draft PR.