Install Streamlit

Prerequisites

Before you get started, you’re going to need a few things:

If you haven’t already, take a few minutes to read through Main concepts to understand Streamlit’s data flow model.

Set up your virtual environment

Regardless of which package management tool you’re using, we recommend running these commands in a virtual environment. This ensures that the dependencies pulled in for Streamlit don’t impact any other Python projects you’re working on.

Install Streamlit

pip install streamlit

Now run the hello world app to make sure everything is working:

streamlit hello

Import Streamlit

Now that everything’s installed, let’s create a new Python script and import Streamlit.

  1. Create a new Python file named first_app.py, then open it with your IDE or text editor.

  2. Next, import Streamlit.

    import streamlit as st
    # To make things easier later, we're also importing numpy and pandas for
    # working with sample data.
    import numpy as np
    import pandas as pd
    
  3. Run your app. A new tab will open in your default browser. It’ll be blank for now. That’s OK.

    streamlit run first_app.py
    

    Running a Streamlit app is no different than any other Python script. Whenever you need to view the app, you can use this command.

    Tip

    Did you know you can also pass a URL to streamlit run? This is great when combined with Github Gists. For example:

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

  4. You can kill the app at any time by typing Ctrl+c in the terminal.