Metadata-Version: 2.4
Name: streamlit-generate-component
Version: 0.1.0
Summary: CLI to quickly scaffold custom Streamlit components (HTML, CSS, JS and Python) using st.components.v2.component
Author-email: Vinicius de Carvalho Barboza <contato@cafecombug.com>
License: MIT
Project-URL: Repository, https://github.com/mrtrycatch/streamlit-generate-component
Project-URL: Developer’s YouTube channel, https://www.youtube.com/@cafecombug
Keywords: streamlit,cli,components,scaffold,components.v2,st.components.v2
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENCE
Requires-Dist: streamlit>=1.30
Dynamic: license-file

# 🧩 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
