Skip to content

randyzwitch/streamlit-folium

Repository files navigation

streamlit-folium: geospatial made easy in Streamlit!

Run tests each PR

Open in Streamlit

streamlit-folium integrates two great open-source projects in the Python ecosystem: Streamlit and Folium!

Installation

pip install streamlit-folium

or

conda install -c conda-forge streamlit-folium

Usage

Currently, there are two functions defined:

  • st_folium(): a bi-directional Component, taking a Folium/Branca object and plotting to the Streamlit app. Upon mount/interaction with the Streamlit app, st_folium() returns a Dict with selected information including the bounding box and items clicked on
  • folium_static(): takes a folium.Map, folium.Figure, or branca.element.Figure object and displays it in a Streamlit app using the _repr_html() representation created in Folium. This function should be a strict subset the of functionality of the newer st_folium() function, but is great for testing to ensure you have the correct Folium syntax.

Example

PyCafe logo Run and edit this example in Py.Cafe

streamlit_folium example

Contributing

See CONTRIBUTING.md for more details.