Spaces:
Sleeping
Sleeping
File size: 4,429 Bytes
746d2f1 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 |
---
title: Install Streamlit using command line
slug: /get-started/installation/command-line
---
# Install 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](/get-started/installation/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:
1. **Python**
We support [version 3.8 to 3.12](https://www.python.org/downloads/).
1. **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](https://realpython.com/python-virtual-environments-a-primer/).
For this guide, we'll be using `venv`, which comes with Python.
1. **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.
1. **Only on MacOS: Xcode command line tools**
Download Xcode command line tools using [these instructions](https://mac.install.guide/commandlinetools/4.html)
in order to let the package manager install some of Streamlit's dependencies.
1. **A code editor**
Our favorite editor is [VS Code](https://code.visualstudio.com/download), which is also what we use in
all our tutorials.
## Create an environment using `venv`
1. Open a terminal and navigate to your project folder.
```bash
cd myproject
```
2. In your terminal, type:
```bash
python -m venv .venv
```
3. A folder named ".venv" will appear in your project. This directory is where your virtual environment and its dependencies are installed.
## Activate your environment
4. In your terminal, activate your environment with one of the following commands, depending on your operating system.
```bash
# Windows command prompt
.venv\Scripts\activate.bat
# Windows PowerShell
.venv\Scripts\Activate.ps1
# macOS and Linux
source .venv/bin/activate
```
5. Once activated, you will see your environment name in parentheses before your prompt. "(.venv)"
## Install Streamlit in your environment
6. In the terminal with your environment activated, type:
```bash
pip install streamlit
```
7. Test that the installation worked by launching the Streamlit Hello example app:
```bash
streamlit hello
```
If this doesn't work, use the long-form command:
```bash
python -m streamlit hello
```
8. Streamlit's Hello app should appear in a new tab in your web browser!
<Cloud src="https://doc-mpa-hello.streamlit.app/?embed=true" height="700" />
9. Close your terminal when you are done.
## Create a "Hello World" app and run it
10. Create a file named `app.py` in your project folder.
```python
import streamlit as st
st.write("Hello world")
```
11. 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:
```bash
# Windows command prompt
.venv\Scripts\activate.bat
# Windows PowerShell
.venv\Scripts\Activate.ps1
# macOS and Linux
source .venv/bin/activate
```
12. Once activated, you will see your environment's name in parentheses at the beginning of your terminal prompt. "(.venv)"
13. Run your Streamlit app.
```bash
streamlit run app.py
```
If this doesn't work, use the long-form command:
```bash
python -m streamlit run app.py
```
14. To stop the Streamlit server, press `Ctrl+C` in the terminal.
15. When you're done using this environment, return to your normal shell by typing:
```bash
deactivate
```
## What's next?
Read about our [Basic concepts](/get-started/fundamentals/main-concepts) to understand Streamlit's dataflow model.
|