diff --git a/content/get-started/installation/_index.md b/content/get-started/installation/_index.md index ef8123c83..f38421b5e 100644 --- a/content/get-started/installation/_index.md +++ b/content/get-started/installation/_index.md @@ -1,15 +1,15 @@ --- -title: Install Streamlit +title: Set up your Streamlit development environment slug: /get-started/installation --- -# Install Streamlit +# Set up your Streamlit development environment There are multiple ways to set up your development environment and install Streamlit. Read below to understand these options. Developing locally with Python installed on your own computer is the most common scenario. -## Summary for experts +## Quick setup for experienced Python developers 1. Set up your Python development environment. 2. Run: @@ -22,43 +22,60 @@ common scenario. ``` 4. Jump to our [Basic concepts](/get-started/fundamentals/main-concepts). -## Installation steps for the rest of us - - - - - -
Option 1: I'm comfortable with the command line
- -Install Streamlit on your own machine using tools like `venv` and `pip`. - - - - - -
Option 2: I prefer a graphical interface
- -Install Streamlit using the Anaconda Distribution graphical user interface. This is also the best -approach if you're on Windows or don't have Python set up. - - - - - -
Option 3: I'd rather use a cloud-based environment
- -Use Streamlit Community Cloud with GitHub Codespaces so you don't have to go through the trouble -of installing Python and setting up an environment. - - - - - -
Option 4: I need something secure, controlled, and in the cloud
- -Use Streamlit in Snowflake to code your apps in the cloud, right alongside your -data with role-based access controls. - - - - +## Setup options for everyone else + +There are many ways to get started coding with Streamlit. If you're brand new to Streamlit or just passing through on a random internet walk, we recommend using the Streamlit Playground for your first hands-on experience. It's quick and ready to go in your browser. After you experience the awesomeness of Streamlit, we're confident you'll want to come back and set up a full development environment, which you can do locally or in the cloud, as described in the options below. + + + "Let me try it out as fast and easy as possible."
+ Try out Streamlit in your browser. Visit the Streamlit Playground and start playing with code in seconds. + + +### Local development options + +

+ + + "I'm comfortable with the command line."
+ Install Streamlit on your own machine using tools like `venv` and `pip`. + "I prefer a graphical interface."
+ Install Streamlit using the Anaconda Distribution graphical user interface. This is also the best approach if you're on Windows or + don't have Python set up yet. + + +### Cloud development options + +

+ + + "I want a preconfigured, cloud-based Docker environment."
+ Use Streamlit Community Cloud with GitHub Codespaces so you don't have to go through the trouble of + installing Python and setting up an environment. + "I need something secure, controlled, and in the cloud."
+ Use Streamlit in Snowflake to code your apps in the cloud, right alongside your data with role-based access controls. + diff --git a/content/get-started/installation/streamlit-playground.md b/content/get-started/installation/streamlit-playground.md new file mode 100644 index 000000000..839b0a481 --- /dev/null +++ b/content/get-started/installation/streamlit-playground.md @@ -0,0 +1,65 @@ +--- +title: Use Streamlit Playground in your browser +slug: /get-started/installation/streamlit-playground +--- + +# Use Streamlit Playground in your browser + +The fastest way to try out Streamlit is to try out our Playground! Streamlit Playground runs in your browser. Just visit the Playground, and a _limited_ version of Streamlit loads as browser scripts. + +Enjoy the following conveniences: + +- Start playing with code right away, completely in your browser. +- No configuration. +- No command line. +- No application installations in your OS. + + + Although the Playground has everything you need to get started, it doesn't contain the full version of Streamlit. To access the full awesomeness of Streamlit, see [Install Streamlit using command line](/get-started/installation/command-line) or [Install Streamlit using Anaconda Distribution](/get-started/installation/anaconda-distribution). + + +## Prerequisites + +Because the Playground runs Streamlit _locally_ in your browser, you should visit the Playground from a personal computer, not a mobile device. + +## Go to the Playground + +1. Go to [streamlit.io/playground](https://streamlit.io/playground). + +1. Wait for [`stlite`](https://github.com/whitphx/stlite) — a browser-based version of Streamlit — to load in your browser. + + This can take as little as a few seconds. The setup time can vary depending on your machine and internet connection. When Streamlit is done loading, an example app is displayed in the right panel. + + ![Streamlit Playground is fully loaded and ready to accept code edits](/images/get-started/Playground-1-loaded.png) + +## Create a `Hello World` app + +1. From the "EXAMPLES" list, select "**Blank**." + +1. On the left, update the contents of the code editor to contain the following code: + + ```python + import streamlit as st + + st.write("Hello World") + ``` + + A second or two after typing or pasting the code into the editor, the right panel will display the updated app. The code editor saves your edits whenever you pause from typing. Therefore, if you pause between keystrokes as you type a new line of code, you may see an error on the right because Streamlit executed an incomplete line. If this happens, just keep typing to complete the line(s) you are writing. When you pause again at the end of the line, Streamlit reruns the app. + +1. On the left, change `st.write` to `st.title` so the code editor has the following code: + + ```python + import streamlit as st + + st.title("Hello World") + ``` + + A second after you stop typing, Streamlit reruns the app and updates the display on the right. + +1. Keep making changes! Watch as your edits are automatically saved and the new result is displayed on the right. + +## What's next? + +Read about our [Basic concepts](/get-started/fundamentals/main-concepts) and try out more commands in your app. + +When you use the Streamlit Playground to work through the basic concepts, you can skip over any instructions to save your file or to select "**Rerun on save**." Streamlit Playground automatically saves your code when you pause from editing, as described above. Also, it is already configured to rerun on save. diff --git a/content/menu.md b/content/menu.md index d9fe371fd..fab594000 100644 --- a/content/menu.md +++ b/content/menu.md @@ -4,15 +4,19 @@ site_menu: url: /get-started color: orange-70 icon: rocket_launch - - category: Get started / Installation + - category: Get started / Setup url: /get-started/installation - - category: Get started / Installation / Use command line + - category: Get started / Setup / LOCAL DEVELOPMENT + - category: Get started / Setup / Use Streamlit Playground ✨ + url: /get-started/installation/streamlit-playground + - category: Get started / Setup / Install via command line url: /get-started/installation/command-line - - category: Get started / Installation / Use Anaconda Distribution + - category: Get started / Setup / Install via Anaconda Distribution url: /get-started/installation/anaconda-distribution - - category: Get started / Installation / Use GitHub Codespaces + - category: Get started / Setup / CLOUD DEVELOPMENT + - category: Get started / Setup / Use GitHub Codespaces url: /get-started/installation/community-cloud - - category: Get started / Installation / Use Snowflake + - category: Get started / Setup / Use Snowflake url: /get-started/installation/streamlit-in-snowflake - category: Get started / Fundamentals url: /get-started/fundamentals diff --git a/public/images/get-started/Playground-1-loaded.png b/public/images/get-started/Playground-1-loaded.png new file mode 100644 index 000000000..b95c7714d Binary files /dev/null and b/public/images/get-started/Playground-1-loaded.png differ