CLI to quickly scaffold custom Streamlit components (HTML, CSS, JS and Python) using st.components.v2.component
Project description
🧩 streamlit-generate-component
A simple CLI to quickly scaffold custom components for Streamlit.
It generates everything you need to get started:
- HTML
- CSS
- JavaScript
- Python wrapper using
st.components.v2.component
Ideal for developers who want to organize their components and start quickly with a ready-to-use template.
🚀 Installation
pip install streamlit-generate-component
⚡ Usage
streamlit-generate-component my_component
or
streamlit-gc my_component
or
st-gc my_component
This will generate:
my_component/
├── __init__.py
├── my_component.py
├── my_component.html
├── my_component.css
└── my_component.js
🧪 Example
import streamlit as st
from my_component import my_component
my_component()
🔥 Features
- One-command component scaffolding
- Organized structure
- Ready to plug into any Streamlit app
🛠 Requirements
- Python 3.8+
- Streamlit
Developer’s YouTube channel
https://www.youtube.com/@cafecombug
📄 License
MIT
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file streamlit_generate_component-0.1.0.tar.gz.
File metadata
- Download URL: streamlit_generate_component-0.1.0.tar.gz
- Upload date:
- Size: 3.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
198465cc91b12e9ac72083949fb1127af8c06620b9ddbf34b28d6ec5d99f0fb2
|
|
| MD5 |
955f5f0d698ac52253d5ae7d7ff42ba9
|
|
| BLAKE2b-256 |
f79aa927bbb268719e5a9db84600c2ffb3f9c8aa97e6aa874a7e4c55016d3e83
|
File details
Details for the file streamlit_generate_component-0.1.0-py3-none-any.whl.
File metadata
- Download URL: streamlit_generate_component-0.1.0-py3-none-any.whl
- Upload date:
- Size: 4.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bb4e85b50766accfe3f5e157d9d7b89b65cb4338f9002a84857e77ef19b25462
|
|
| MD5 |
a23f97daa3b656b6aa5efbd45f37e2cc
|
|
| BLAKE2b-256 |
3d331652bd2f8c31ac1dc71f435c32cf3da75cd056356acb1e276c9923d9ff5d
|
