Documentation  Search Ctrl-K 

Home / Streamlit library / Cheat sheet

 Streamlit library

Get started 
Cheat Sheet
API reference  This is a summary of the docs, as of Streamlit v1.29.0.

Advanced features 
Install & Import Command line
Components 
streamlit run first_app.py streamlit --help
Roadmap 
streamlit run your_script.py
Changelog # Import convention streamlit hello

>>> import streamlit as st streamlit config show

Cheat sheet
streamlit cache clear

streamlit docs
 Streamlit Community Cloud
streamlit --version

Get started 

Deploy your app  Pre-release features

Manage your app  pip uninstall streamlit

pip install streamlit-nightly --upgrade

Share your app 

Manage your account  Learn more about experimental features

Magic commands Build chat-based apps

# Magic commands implicitly # Insert a chat message container.

# call [Link](). >>> with st.chat_message("user"):

'_This_ is some **Markdown***' >>> [Link]("Hello 👋")

my_variable >>> st.line_chart([Link](30, 3))

'dataframe:', my_data_frame
# Display a chat input widget.

>>> st.chat_input("Say something")

Display text
[Link]('Fixed width text') Learn how to Build a basic LLM chat app

[Link]('_Markdown_') # see *

[Link](r''' e^{i\pi} + 1 = 0 ''') Mutate data

[Link]('Most objects') # df, err, func, keras! # Add rows to a dataframe after

[Link](['st', 'is <', 3]) # see * # showing it.

[Link]('My title') >>> element = [Link](df1)

[Link]('My header') >>> element.add_rows(df2)

[Link]('My sub')

[Link]('for i in range(8): foo()') # Add rows to a chart after

* optional kwarg unsafe_allow_html = True # showing it.

>>> element = st.line_chart(df1)

>>> element.add_rows(df2)
Display data
[Link](my_dataframe)

[Link]([Link][0:10]) Display code

[Link]({'foo':'bar','fu':'ba'}) >>> with [Link]():
[Link]('My metric', 42, 2) >>> [Link]('Code will be executed and printed')

Display media Placeholders, help, and options

[Link]('./[Link]') # Replace any single element.
[Link](data) >>> element = [Link]()
[Link](data) >>> element.line_chart(...)

>>> element.text_input(...) # Replaces previous.

Display charts # Insert out of order.

st.area_chart(df) >>> elements = [Link]()
st.bar_chart(df) >>> elements.line_chart(...)
st.line_chart(df) >>> [Link]("Hello")
[Link](df) >>> elements.text_input(...) # Appears above "Hello".
st.scatter_chart(df)

[Link]([Link])
st.altair_chart(chart)
st.get_option(key)
st.bokeh_chart(fig)
st.set_option(key, value)
st.graphviz_chart(fig) st.set_page_config(layout='wide')
st.plotly_chart(fig) st.experimental_get_query_params()
st.pydeck_chart(chart) st.experimental_set_query_params(**params)
[Link](fig)
st.vega_lite_chart(df)

Connect to data sources

[Link]("pets_db", type="sql")
Add widgets to sidebar
conn = [Link]("sql")
# Just add it after [Link]:
conn = [Link]("snowflake")
>>> a = [Link]('Select one:', [1, 2])

>>> class MyConnection(BaseConnection[[Link]

# Or use "with" notation:
>>> def _connect(self, **kwargs) -> MyConnection:
>>> with [Link]: >>> return [Link](**self._secrets, **kwar
>>> [Link]('Select one:', [1, 2]) >>> def query(self, query):

>>> return self._instance.query(query)

Columns
# Two equal columns:
Optimize performance
>>> col1, col2 = [Link](2)

>>> [Link]("This is column 1") Cache data objects

>>> [Link]("This is column 2") # E.g. Dataframe computation, storing downloaded data, e

>>> @st.cache_data

# Three different columns: ... def foo(bar):

>>> col1, col2, col3 = [Link]([3, 1, 1]) ... # Do something expensive and return data

# col1 is larger. ... return data

# Executes foo

# You can also use "with" notation: >>> d1 = foo(ref1)

>>> with col1: # Does not execute foo

>>> [Link]('Select one:', [1, 2]) # Returns cached item by value, d1 == d2

>>> d2 = foo(ref1)

# Different arg, so function foo executes

Tabs >>> d3 = foo(ref2)
# Insert containers separated into tabs: # Clear all cached entries for this function
>>> tab1, tab2 = [Link](["Tab 1", "Tab2"]) >>> [Link]()
>>> [Link]("this is tab 1") # Clear values from *all* in-memory or on-disk cached fu
>>> [Link]("this is tab 2") >>> st.cache_data.clear()

# You can also use "with" notation:

>>> with tab1: Cache global resources

>>> [Link]('Select one:', [1, 2]) # E.g. TensorFlow session, database connection, etc.

>>> @st.cache_resource

... def foo(bar):

Control flow ... # Create and return a non-data object
# Stop execution immediately: ... return session
[Link]() # Executes foo
# Rerun script immediately: >>> s1 = foo(ref1)
[Link]() # Does not execute foo

# Returns cached item by reference, s1 == s2

# Group multiple widgets: >>> s2 = foo(ref1)
>>> with [Link](key='my_form'): # Different arg, so function foo executes
>>> username = st.text_input('Username') >>> s3 = foo(ref2)
>>> password = st.text_input('Password') # Clear all cached entries for this function
>>> st.form_submit_button('Login') >>> [Link]()

# Clear all global resources from cache

>>> st.cache_resource.clear()
Display interactive widgets
[Link]("Click me")

st.download_button("Download file", data) Deprecated caching

st.link_button("Go to gallery", url) >>> @[Link]

st.data_editor("Edit data", data) ... def foo(bar):

[Link]("I agree") ... # Do something expensive in here...

[Link]("Enable") ... return data

[Link]("Pick one", ["cats", "dogs"]) >>> # Executes foo

[Link]("Pick one", ["cats", "dogs"]) >>> d1 = foo(ref1)

[Link]("Buy", ["milk", "apples", "potatoes"]) >>> # Does not execute foo

[Link]("Pick a number", 0, 100) >>> # Returns cached item by reference, d1 == d2

st.select_slider("Pick a size", ["S", "M", "L"]) >>> d2 = foo(ref1)
st.text_input("First name") >>> # Different arg, so function foo executes
st.number_input("Pick a number", 0, 10) >>> d3 = foo(ref2)
st.text_area("Text to translate")

st.date_input("Your birthday")
st.time_input("Meeting time") Display progress and status
st.file_uploader("Upload a CSV") # Show a spinner during a process
st.camera_input("Take a picture") >>> with [Link](text='In progress'):
st.color_picker("Pick a color") >>> [Link](3)

>>> [Link]('Done')
# Use widgets' returned values in variables:

>>> for i in range(int(st.number_input('Num:'))): # Show and update progress bar

>>> foo() >>> bar = [Link](50)
>>> if [Link]('I:',['f']) == 'f': >>> [Link](3)
>>> b() >>> [Link](100)
>>> my_slider_val = [Link]('Quinn Mallory', 1, 88)
>>> [Link](slider_val) >>> with [Link]('Authenticating...') as s:
>>> [Link](2)
# Disable widgets to remove interactivity: >>> [Link]('Some long response.')
>>> [Link]('Pick a number', 0, 100, disabled=True) >>> [Link](label='Response')

[Link]()
[Link]()

[Link]('Warming up...')
[Link]('Error message')

[Link]('Warning message')
[Link]('Info message')

[Link]('Success message')
[Link](e)

Personalize apps for users

# Show different content based on the user's email addre

>>> if [Link] == 'jane@[Link]':

>>> display_jane_content()
>>> elif [Link] == 'adam@[Link]':

>>> display_adam_content()
>>> else:

>>> [Link]("Please contact us to get access!")

Previous: Changelog Next: Streamlit Community Cloud

Still have questions?

 Our forums are full of helpful information and Streamlit experts.

Was this page helpful?  Yes  No  Edit this page on GitHub

Home Contact Us Community

Copyright © 2023, Streamlit Inc. Cookie policy