How do I run my Streamlit script?

Working with Streamlit is simple. First you sprinkle a few Streamlit commands into a normal Python script, and then you run it. We list few ways to run your script, depending on your use case.

Use streamlit run

Once you've created your script, say your_script.py, the easiest way to run it is with streamlit run:

streamlit run your_script.py

As soon as you run the script as shown above, a local Streamlit server will spin up and your app will open in a new tab your default web browser.

Pass arguments to your script

When passing your script some custom arguments, they must be passed after two dashes. Otherwise the arguments get interpreted as arguments to Streamlit itself:

streamlit run your_script.py [-- script args]

Pass a URL to streamlit run

You can also pass a URL to streamlit run! This is great when your script is hosted remotely, such as a Github Gist. For example:

streamlit run https://raw.githubusercontent.com/streamlit/demo-uber-nyc-pickups/master/streamlit_app.py

Run Streamlit as a Python module

Another way of running Streamlit is to run it as a Python module. This is useful when configuring an IDE like PyCharm to work with Streamlit:

# Running
python -m streamlit your_script.py

# is equivalent to:
streamlit run your_script.py