Metadata-Version: 2.4
Name: ctlib-streamlit-extras
Version: 0.1.0
Summary: Reusable React-based Streamlit extras.
Project-URL: Homepage, https://git.codetech.top/ctlib/ctlib-streamlit-extras.git
Author-email: Jimin <jimin@codetech.top>
License-Expression: MIT
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.10
Requires-Dist: pydantic<3,>=2
Requires-Dist: streamlit<2,>=1.36
Description-Content-Type: text/markdown

# ctlib-streamlit-extras

React-based Streamlit custom components packaged as a reusable Python library.

Docs:

- [Framework](docs/framework.md)
- [App](docs/app.md)
- [Page State](docs/page_state.md)
- [Context](docs/context.md)
- [Middleware](docs/middleware.md)
- [Button](docs/button.md)

## Install

```bash
pip install ctlib-streamlit-extras
```

## Usage

See the docs for the current framework and button APIs:

- [Framework](docs/framework.md)
- [Button](docs/button.md)

## Examples

Run the multi-page Streamlit demo app:

```bash
poetry run streamlit run examples/Home.py
```

## Development

Install frontend dependencies and build the React bundle:

```bash
cd frontend
npm install
npm run build
```

Then install the package locally:

```bash
python -m pip install setuptools wheel
pip install -e .
```
