https://github.com/arnaudmiribel/streamlit-kickoff-cli

A simple CLI to kickoff and manage Streamlit projects
https://github.com/arnaudmiribel/streamlit-kickoff-cli

Last synced: 3 months ago
JSON representation

A simple CLI to kickoff and manage Streamlit projects

• Host: GitHub
• URL: https://github.com/arnaudmiribel/streamlit-kickoff-cli
• Owner: arnaudmiribel
• License: mit
• Created: 2021-11-22T14:35:57.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-09-11T17:46:36.000Z (over 2 years ago)
• Last Synced: 2024-09-28T13:41:19.903Z (4 months ago)
• Language: Python
• Homepage:
• Size: 13.2 MB
• Stars: 27
• Watchers: 4
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# streamlit-kickoff-cli 👞

[![PyPI](https://img.shields.io/pypi/v/streamlit-kickoff-cli)](https://pypi.org/project/streamlit-kickoff-cli/)



**A simple CLI to kickoff and manage Streamlit projects**

`stk` is a command-line interface that helps you create, manage and iterate on your Streamlit projects!

---



    



---

## Installation

This is a working setup using Mac OSX & VS Code.

```bash

pip install streamlit-kickoff-cli

```

## Usage

```

$ stk --help

Usage: stk [OPTIONS] COMMAND [ARGS]...

  Welcome to stk 👞

  This is a simple CLI to help you kick off and maintain Streamlit projects as

  fast as possible!

Options:

  --help  Show this message and exit.

Commands:

  new   🆕 Create a new Streamlit project

  dev   👩‍💻 Dev time! Opens VS Code and your app in Chrome!

  kick  🚀 New app + dev set up NOW!

  list  🤯 List running Streamlit apps under ports 85**

  kill  🔫 Kill a given Streamlit app running locally!

```

## Troubleshooting

- Make sure your CLI can access VS Code. See [this link](https://stackoverflow.com/a/40129135/6159698).

- If you get `xcrun: error: invalid active developer path`... error:

Visit https://apple.stackexchange.com/a/254381 or run:

```

xcode-select --install

```