🎈 `st` is a CLI to quickly kick-off your new Streamlit project

Last update: Dec 19, 2022

Related tags

Command-line Tools st

Overview

🎈 `st` - a friendly Streamlit CLI

st is a CLI that helps you kick-off a new Streamlit project so you can start crafting the app as soon as possible!

How it works

✨ Simple as:

$ st .

demo_quick.mov

🚀 Usage

Prerequisites

This is a working setup for anyone using Microsoft VS Code. Has been tested solely on Mac OSX.

Manually

Install requirements:

pip install -r requirements.txt

Make sure to enable your CLI to access VS Code. See this link.
Add the alias to your ~/.bashrc:

# Alias for st
alias st='python ~/your/path/to/st/st.py -p'

Source it:

source ~/.bash_profile

Getting started

Run:

$ st {directory}

Documentation

$ python st.py --help

Usage: st.py [OPTIONS]

Options:
  -p, --path TEXT                 Path where you want to create your Streamlit
                                  project.

  --open_project_in_vs_code INTEGER
                                  Open VS code with the newly created file.
  --run_app INTEGER               Run Streamlit script
  --open_app_in_browser INTEGER   Open Streamlit app in browser
  --help                          Show this message and exit.

Troubleshooting

If you get xcrun: error: invalid active developer path... error:
Visit https://apple.stackexchange.com/a/254381 or run:

xcode-select --install

Comments

Cookiecutter, tests and new API

📚 Context

Adding some work on top of what @snehankekre started! Inspired by thoughts in here

🧠 Description of changes

On top of https://github.com/arnaudmiribel/st/pull/3:

Replaced pip with pip3 and python with python3
Added tests for GitHub URL validation and parsing
Better .gitignore!
Now using st-cookiecutter to enable customizing the template

🔥 In addition, now supporting...

$python3 main.py
Usage: main.py [OPTIONS] COMMAND [ARGS]...

  🎈 Welcome to st 🎈

  This is an experimental CLI to help you kick off and maintain Streamlit
  projects as fast as possible!

Options:
  --help  Show this message and exit.

Commands:
  clone  👯 Clone an existing Streamlit project
  go     😎 Open VS Code and your app in Chrome!
  kill   🔫 Kill a given Streamlit app running locally!
  list   🤯 List running Streamlit apps under ports 85**
  new    🆕 Create a new Streamlit project from an empty template

clone:

python3 main.py clone https://github.com/arnaudmiribel/stoggle/blob/main/streamlit_app.py 
➕ Cloning repo https://github.com/arnaudmiribel/stoggle
➕ Changing directory to 'app/'
➕ Creating a new environment with venv
➕ Installing dependencies
DEPRECATION: Configuring installation scheme with distutils config files is deprecated and will no longer work in the near future. If you are using a Homebrew or Linuxbrew Python, please see discussion at https://github.com/Homebrew/homebrew-core/issues/76621
DEPRECATION: Configuring installation scheme with distutils config files is deprecated and will no longer work in the near future. If you are using a Homebrew or Linuxbrew Python, please see discussion at https://github.com/Homebrew/homebrew-core/issues/76621
WARNING: You are using pip version 22.0.4; however, version 22.1.2 is available.
You should consider upgrading via the '/usr/local/opt/[email protected]/bin/python3.9 -m pip install --upgrade pip' command.
➕ Opening project in VS Code...
➕ Running app...

list:

$python3 main.py list

Let's look at your apps running locally...
                       App URL
App ID                        
1110    http://localhost:8501

kill:

$python3 main.py kill --id 1110
Killing 1110...

new:

$python3 main.py new

You just asked for a `new` Streamlit project. Let's go!
New directory name [app]: 
Want to customize the template? [y/N]: y
Title of your app [Balloons]: Surfin' USA
Will you be using secrets? [Y/n]:  
Will your app use more than one page? [Y/n]: 
Are you connecting to Snowflake in this app? [y/N]: y


🎉 Successfully created your new Streamlit app in directory 'app'!

🖥️ Test!

Clone this repo and go on this branch
Now go ahead and try out python3 main.py!

opened by arnaudmiribel 2

Support GitHub url of main script
:books: Context

@arnaudmiribel you had mentioned that you'd someday like to support st {template}, where template is a GitHub repo. This PR makes incremental progress towards that vision.

:brain: Description of changes

Supports st {template}, where template is the GitHub (.py) url of the main script. E.g.

st https://github.com/streamlit/streamlit-example/blob/master/streamlit_app.py

Creates a virtualenv with venv

TODO

Refactor into functions to more conveniently reuse code

Support Conda, Poetry
opened by snehankekre 1
added a couple new features

Hey @arnaudmiribel, I thought it might be interesting to add a snowflake flag that automatically adds space in the secrets file for usernames, passwords, etc, and also adds a sample query. This isn't exactly ready yet (mostly because the streamlit app doesn't work OOB with this setup), but I just wanted to toss this idea by you (i'm also super bored)

opened by tylerjrichards 1
Refactoring + CI
Split all main.py into multiple files, one for the entrypoint and one for each command (within their own subdirectory)

Remove unused functions

Set up GitHub Action for releases to PyPi
opened by arnaudmiribel 0

Show main file name in `st list`

Shows the Streamlit apps' main file name in the output of st list:

$python3 main.py list

Let's look at your apps running locally...
                       App URL          Main file
App ID                                           
6487    http://localhost:8501              yes.py
7121    http://localhost:8502             user.py
9239    http://localhost:8505   get_mainscript.py

opened by snehankekre 0

Releases(v0.1.1)

v0.1.1(Sep 11, 2022)

Source code(tar.gz)
Source code(zip)
v0.1.0(Sep 11, 2022)
What's Changed

Support GitHub url of main script by @snehankekre in https://github.com/arnaudmiribel/streamlit-kickoff-cli/pull/3

Show main file name in st list by @snehankekre in https://github.com/arnaudmiribel/streamlit-kickoff-cli/pull/5

Cookiecutter, tests and new API by @arnaudmiribel in https://github.com/arnaudmiribel/streamlit-kickoff-cli/pull/4

Pass directory name even if not customizing template by @blackary in https://github.com/arnaudmiribel/streamlit-kickoff-cli/pull/6

Handle cases where python is a substring of the command by @blackary in https://github.com/arnaudmiribel/streamlit-kickoff-cli/pull/7

Refactoring + CI by @arnaudmiribel in https://github.com/arnaudmiribel/streamlit-kickoff-cli/pull/8

New Contributors

@snehankekre made their first contribution in https://github.com/arnaudmiribel/streamlit-kickoff-cli/pull/3

@arnaudmiribel made their first contribution in https://github.com/arnaudmiribel/streamlit-kickoff-cli/pull/4

@blackary made their first contribution in https://github.com/arnaudmiribel/streamlit-kickoff-cli/pull/6

Full Changelog: https://github.com/arnaudmiribel/streamlit-kickoff-cli/commits/v0.0.4
Source code(tar.gz)
Source code(zip)

Owner

Arnaud

GitHub Repository

Postgres CLI with autocompletion and syntax highlighting

A REPL for Postgres This is a postgres client that does auto-completion and syntax highlighting. Home Page: http://pgcli.com MySQL Equivalent: http://

10.8k Jan 02, 2023

Tools crack instagram + fb ayok dicoba keburu premium 😁

FITUR INSTALLASI [1] pkg update && pkg upgrade [2] pkg install git [3] pkg install python [4] pkg install python2 [5] pkg install nano [6]

1 Dec 11, 2021

A tool to manage the study of courses at the university.

todo-cli A tool to manage the study of courses at the university

6 Aug 01, 2022

Management commands to help backup and restore your project database and media files

Django Database Backup This Django application provides management commands to help backup and restore your project database and media files with vari

687 Jan 04, 2023

Convert shellcode into :sparkles: different :sparkles: formats!

Bluffy Convert shellcode into ✨ different ✨ formats! Bluffy is a utility which was used in experiments to bypass Anti-Virus products (statically) by f

305 Dec 17, 2022

🌈 Generate color palettes based on Neovim colorschemes.

Iris Iris is a Neovim plugin that generates a normalized color palette based on your colorscheme. It is named for the goddess Iris of Greek mythology,

45 Jul 28, 2022

f90nml - A Fortran namelist parser, generator, and editor

f90nml - A Fortran namelist parser, generator, and editor A Python module and command line tool for parsing Fortran namelist files Documentation The c