A new CLI to kick-off your Streamlit projects!

Hey there,

Excited to introduce st-kickoff, a CLI I have developed to help me start new Streamlit apps as quickly as possible. :dash:

How to install? pip install st-kickoff
How to use? Simply run st in a new directory… and it will:

  • Create a basic Streamlit project structure in your directory:
.
β”œβ”€β”€ .gitignore         # basic .gitignore to ignore Streamlit secrets!
β”œβ”€β”€ .streamlit
β”‚   └── secrets.toml   # empty Streamlit Secrets
β”œβ”€β”€ README.md          # basic README
β”œβ”€β”€ requirements.txt   # empty
└── streamlit_app.py   # basic Streamlit template app
  • Open the project & script in VS Code
  • Run the Streamlit app
  • Open the app in your browser

Demo:

Hope you like it, hope it works for you, and please don’t hesitate to share feedback and contribute!
Best,

Arnaud

8 Likes

Great idea! I had β€œsolved” this need by having a github template for streamlit, but I like better this approach! Can use it directly on local. Bravo.

Thanks @sebastiandres!

Actually you have a point, the CLI could also simply create a repo based on a template GitHub repository. See gh repo create --template in the GitHub CLI. The repo could be a parameter. And it keeps doing additional stuffs (opening VS Code + browser + running the server)

st {template_repo}

where template_repo is default to e.g. arnaudmiribel/my-streamlit-template which would have the current settings but you could use any.

Downside is the additional requirement of GitHub CLI.

1 Like

Great tips, thanks!

1 Like

Great work, Arnaud! Thanks for sharing with us! :pray:

Charly