We built this in 5 mins https://simple-cheatsheet.streamlit.app/
- Create a free Streamlit account
- Install Streamlit
pip install streamlit
.
- Create a new repo, and clone it to your local machine.
- Create a
README.md and streamlit_app.py and a requirements.txt
file in that repo. - Develop your app in the streamlit_app.py
- Add your requirements to the requirements.txt
- Add any instructions to the readme.
- Push your changes back to github.
- Run the app locally using
streamlit run streamlit_app.py
- That will open the app locally, and you will see a deploy button in the top right. Click and follow the instructions.
- Click create app (top right corner).
- Follow the prompts of linking your github, and then choose a template or a blank app.
- Change the domain and name of your app to whatever you want/is available.
- OPTIONAL: If you want to develop / code it in the cloud, Check the 'open github spaces' box, 0. Click Deploy.
-- Im going to do it local as well because im using cellphone for data.
- First you need to get the files on your local machine... To do that open github by clicking the github icon (see image below). That will open the repo that was automatically created. Then clone that repo locally. .
- You should now see all the files in your local machine.
I would first just do pip install streamlit
, however, you can also run the requirements.
-
Install the requirements
$ pip install -r requirements.txt
-
Run the app
$ streamlit run streamlit_app.py
To run any streamlit app, you just type in streamlit run <name_of_app_file.py>
. Above we are running the streamlit app that is coded in the streamlit_app.py
file.
- Open the
streamlit_app.py
file in your favorite IDE text editor. - Open the webpage of the streamlit cheat sheet
- Create a new python file named
bio.py
. - Open it and first, at the top include
import streamlit as st
. - Add your name via any of the text methods listed in the cheat sheet. (My favorite is
st.markdown("# Hi, I'm Zack")
).
0.0 Streamlit markdown uses Github Flavored Markdown. Here is a cheat sheet for github flavored markdown formatting