DocumentationsearchSearchrocket_launchGet startedInstallationremoveUse command lineUse Anaconda DistributionUse GitHub CodespacesUse SnowflakeFundamentalsaddFirst stepsaddcodeDevelopConceptsaddAPI referenceaddTutorialsaddQuick referenceaddweb_assetDeployConceptsaddStreamlit Community CloudaddStreamlit in Snowflakeopen_in_newOther platformsaddschoolKnowledge baseFAQInstalling dependenciesDeployment issuesHome/Get started/Installation/Use command lineInstall Streamlit using command line
This page will walk you through creating an environment with venv and installing Streamlit with pip. These are our recommended tools, but if you are familiar with others you can use your favorite ones too. At the end, you'll build a simple "Hello world" app and run it. If you prefer to have a graphical interface to manage your Python environments, check out how to Install Streamlit using Anaconda Distribution.
Prerequisites
As with any programming tool, in order to install Streamlit you first need to make sure your
computer is properly set up. More specifically, you’ll need:


Python
We support version 3.8 to 3.12.


A Python environment manager (recommended)
Environment managers create virtual environments to isolate Python package installations between
projects.
We recommend using virtual environments because installing or upgrading a Python package may
cause unintentional effects on another package. For a detailed introduction to Python
environments, check out
Python Virtual Environments: A Primer.
For this guide, we'll be using venv, which comes with Python.


A Python package manager
Package managers handle installing each of your Python packages, including Streamlit.
For this guide, we'll be using pip, which comes with Python.


Only on MacOS: Xcode command line tools
Download Xcode command line tools using these instructions
in order to let the package manager install some of Streamlit's dependencies.


A code editor
Our favorite editor is VS Code, which is also what we use in
all our tutorials.


Create an environment using venv


Open a terminal and navigate to your project folder.
cd myproject



In your terminal, type:
python -m venv .venv



A folder named ".venv" will appear in your project. This directory is where your virtual environment and its dependencies are installed.


Activate your environment


In your terminal, activate your environment with one of the following commands, depending on your operating system.
# Windows command prompt
.venv\Scripts\activate.bat

# Windows PowerShell
.venv\Scripts\Activate.ps1

# macOS and Linux
source .venv/bin/activate



Once activated, you will see your environment name in parentheses before your prompt. "(.venv)"


Install Streamlit in your environment


In the terminal with your environment activated, type:
pip install streamlit



Test that the installation worked by launching the Streamlit Hello example app:
streamlit hello

If this doesn't work, use the long-form command:
python -m streamlit hello



Streamlit's Hello app should appear in a new tab in your web browser!
Built with Streamlit 🎈Fullscreen open_in_new


Close your terminal when you are done.


Create a "Hello World" app and run it

Create a file named app.py in your project folder.

import streamlit as st

st.write("Hello world")


Any time you want to use your new environment, you first need to go to your project folder (where the .venv directory lives) and run the command to activate it:

# Windows command prompt
.venv\Scripts\activate.bat

# Windows PowerShell
.venv\Scripts\Activate.ps1

# macOS and Linux
source .venv/bin/activate



Once activated, you will see your environment's name in parentheses at the beginning of your terminal prompt. "(.venv)"


Run your Streamlit app.


streamlit run app.py

If this doesn't work, use the long-form command:
python -m streamlit run app.py



To stop the Streamlit server, press Ctrl+C in the terminal.


When you're done using this environment, return to your normal shell by typing:


deactivate

What's next?
Read about our Basic concepts to understand Streamlit's dataflow model.Previous: InstallationNext: Use Anaconda DistributionforumStill have questions?Our forums are full of helpful information and Streamlit experts.HomeContact UsCommunity© 2024 Snowflake Inc.Cookie policy