streamlit-stepper 0.1.0__tar.gz

streamlit_stepper-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Your Name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

streamlit_stepper-0.1.0/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include streamlit_stepper/frontend/build *

streamlit_stepper-0.1.0/PKG-INFO

@@ -0,0 +1,177 @@
+Metadata-Version: 2.4
+Name: streamlit-stepper
+Version: 0.1.0
+Summary: A multi-step wizard component for Streamlit with validation and progress tracking
+Home-page: https://github.com/RhythrosaLabs/streamlit-stepper
+Author: Your Name
+Author-email: you@example.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: streamlit>=1.28.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# streamlit-stepper
+
+A multi-step wizard component for Streamlit. Define steps with typed fields, get built-in validation, animated progress connectors, a summary review step, and the final collected values back in Python.
+
+![Stepper screenshot](https://raw.githubusercontent.com/RhythrosaLabs/streamlit-stepper/main/docs/screenshot.png)
+
+## Features
+
+- Horizontal (tabs across top) and vertical (sidebar) orientations — switchable at runtime
+- Animated fill connector between steps as you progress
+- Per-field required validation — blocks Next and shows inline error hints
+- Click completed steps to jump back
+- Auto-generated review step that summarizes all entries
+- Completion screen with collected values
+- Dot-strip navigation at the bottom of each step
+- Zero runtime dependencies beyond Streamlit
+
+## Installation
+
+```bash
+pip install streamlit-stepper
+```
+
+## Quickstart
+
+```python
+import streamlit as st
+from streamlit_stepper import st_stepper
+
+steps = [
+    {
+        "label": "Project",
+        "subtitle": "Name & describe",
+        "icon": "◈",
+        "fields": [
+            {
+                "key": "name",
+                "label": "Project name",
+                "type": "text",
+                "placeholder": "e.g. Apollo Dashboard",
+                "required": True,
+            },
+            {
+                "key": "type",
+                "label": "Project type",
+                "type": "select",
+                "options": ["Web App", "Data Pipeline", "ML Model", "API Service"],
+                "required": True,
+            },
+        ],
+    },
+    {
+        "label": "Team",
+        "subtitle": "Add collaborators",
+        "icon": "◉",
+        "fields": [
+            {
+                "key": "owner",
+                "label": "Owner email",
+                "type": "text",
+                "placeholder": "you@company.com",
+                "required": True,
+            },
+            {
+                "key": "size",
+                "label": "Team size",
+                "type": "select",
+                "options": ["Solo", "2–5", "6–15", "15+"],
+                "required": True,
+            },
+        ],
+    },
+    {
+        "label": "Review",
+        "subtitle": "Confirm & launch",
+        "icon": "◆",
+        "fields": [],  # empty fields = auto review step
+    },
+]
+
+result = st_stepper(steps, orientation="horizontal", key="wizard")
+
+if result and result["completed"]:
+    st.balloons()
+    st.success(f"Created project: {result['values']['name']}")
+    st.json(result["values"])
+```
+
+## API
+
+```python
+st_stepper(steps, orientation="horizontal", key=None)
+```
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| `steps` | `list[dict]` | required | Step definitions |
+| `orientation` | `"horizontal" \| "vertical"` | `"horizontal"` | Layout of the step indicator |
+| `key` | `str` | `None` | Streamlit widget key |
+
+### Step schema
+
+```python
+{
+    "label":    str,        # short name in the indicator (e.g. "Project")
+    "subtitle": str,        # secondary text below label
+    "icon":     str,        # decorative character (e.g. "◈", "①", "→")
+    "fields": [
+        {
+            "key":         str,          # returned in result["values"]
+            "label":       str,          # field display label
+            "type":        str,          # "text" | "textarea" | "select"
+            "placeholder": str,          # optional hint text
+            "required":    bool,         # if True, blocks Next when empty
+            "options":     list[str],    # required for type="select"
+        }
+    ]
+}
+```
+
+A step with `"fields": []` renders as a review summary of all prior steps.
+
+### Return value
+
+```python
+{
+    "step":      int,   # index of the last completed step
+    "values":    dict,  # {field_key: entered_value} for all fields
+    "completed": bool,  # True when user clicks the final submit button
+}
+```
+
+## Development
+
+```bash
+git clone https://github.com/RhythrosaLabs/streamlit-stepper
+cd streamlit-stepper
+
+cd streamlit_stepper/frontend
+npm install
+npm start   # dev server on :3003
+
+# separate terminal
+cd ../..
+pip install -e .
+# Set _RELEASE = False in streamlit_stepper/__init__.py
+streamlit run example.py
+```
+
+## License
+
+MIT

streamlit_stepper-0.1.0/README.md

@@ -0,0 +1,152 @@
+# streamlit-stepper
+
+A multi-step wizard component for Streamlit. Define steps with typed fields, get built-in validation, animated progress connectors, a summary review step, and the final collected values back in Python.
+
+![Stepper screenshot](https://raw.githubusercontent.com/RhythrosaLabs/streamlit-stepper/main/docs/screenshot.png)
+
+## Features
+
+- Horizontal (tabs across top) and vertical (sidebar) orientations — switchable at runtime
+- Animated fill connector between steps as you progress
+- Per-field required validation — blocks Next and shows inline error hints
+- Click completed steps to jump back
+- Auto-generated review step that summarizes all entries
+- Completion screen with collected values
+- Dot-strip navigation at the bottom of each step
+- Zero runtime dependencies beyond Streamlit
+
+## Installation
+
+```bash
+pip install streamlit-stepper
+```
+
+## Quickstart
+
+```python
+import streamlit as st
+from streamlit_stepper import st_stepper
+
+steps = [
+    {
+        "label": "Project",
+        "subtitle": "Name & describe",
+        "icon": "◈",
+        "fields": [
+            {
+                "key": "name",
+                "label": "Project name",
+                "type": "text",
+                "placeholder": "e.g. Apollo Dashboard",
+                "required": True,
+            },
+            {
+                "key": "type",
+                "label": "Project type",
+                "type": "select",
+                "options": ["Web App", "Data Pipeline", "ML Model", "API Service"],
+                "required": True,
+            },
+        ],
+    },
+    {
+        "label": "Team",
+        "subtitle": "Add collaborators",
+        "icon": "◉",
+        "fields": [
+            {
+                "key": "owner",
+                "label": "Owner email",
+                "type": "text",
+                "placeholder": "you@company.com",
+                "required": True,
+            },
+            {
+                "key": "size",
+                "label": "Team size",
+                "type": "select",
+                "options": ["Solo", "2–5", "6–15", "15+"],
+                "required": True,
+            },
+        ],
+    },
+    {
+        "label": "Review",
+        "subtitle": "Confirm & launch",
+        "icon": "◆",
+        "fields": [],  # empty fields = auto review step
+    },
+]
+
+result = st_stepper(steps, orientation="horizontal", key="wizard")
+
+if result and result["completed"]:
+    st.balloons()
+    st.success(f"Created project: {result['values']['name']}")
+    st.json(result["values"])
+```
+
+## API
+
+```python
+st_stepper(steps, orientation="horizontal", key=None)
+```
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| `steps` | `list[dict]` | required | Step definitions |
+| `orientation` | `"horizontal" \| "vertical"` | `"horizontal"` | Layout of the step indicator |
+| `key` | `str` | `None` | Streamlit widget key |
+
+### Step schema
+
+```python
+{
+    "label":    str,        # short name in the indicator (e.g. "Project")
+    "subtitle": str,        # secondary text below label
+    "icon":     str,        # decorative character (e.g. "◈", "①", "→")
+    "fields": [
+        {
+            "key":         str,          # returned in result["values"]
+            "label":       str,          # field display label
+            "type":        str,          # "text" | "textarea" | "select"
+            "placeholder": str,          # optional hint text
+            "required":    bool,         # if True, blocks Next when empty
+            "options":     list[str],    # required for type="select"
+        }
+    ]
+}
+```
+
+A step with `"fields": []` renders as a review summary of all prior steps.
+
+### Return value
+
+```python
+{
+    "step":      int,   # index of the last completed step
+    "values":    dict,  # {field_key: entered_value} for all fields
+    "completed": bool,  # True when user clicks the final submit button
+}
+```
+
+## Development
+
+```bash
+git clone https://github.com/RhythrosaLabs/streamlit-stepper
+cd streamlit-stepper
+
+cd streamlit_stepper/frontend
+npm install
+npm start   # dev server on :3003
+
+# separate terminal
+cd ../..
+pip install -e .
+# Set _RELEASE = False in streamlit_stepper/__init__.py
+streamlit run example.py
+```
+
+## License
+
+MIT

streamlit_stepper-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

streamlit_stepper-0.1.0/setup.py

@@ -0,0 +1,21 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="streamlit-stepper",
+    version="0.1.0",
+    author="Your Name",
+    author_email="you@example.com",
+    description="A multi-step wizard component for Streamlit with validation and progress tracking",
+    long_description=open("README.md").read(),
+    long_description_content_type="text/markdown",
+    url="https://github.com/RhythrosaLabs/streamlit-stepper",
+    packages=find_packages(),
+    include_package_data=True,
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires=">=3.8",
+    install_requires=["streamlit>=1.28.0"],
+)

streamlit_stepper-0.1.0/streamlit_stepper/__init__.py

@@ -0,0 +1,83 @@
+import os
+import streamlit.components.v1 as components
+
+_RELEASE = True
+
+if _RELEASE:
+    _component_func = components.declare_component(
+        "streamlit_stepper",
+        path=os.path.join(os.path.dirname(__file__), "frontend/build"),
+    )
+else:
+    _component_func = components.declare_component(
+        "streamlit_stepper",
+        url="http://localhost:3001",
+    )
+
+
+def st_stepper(steps, orientation="horizontal", key=None):
+    """
+    Render a multi-step wizard with validated fields and progress tracking.
+
+    Parameters
+    ----------
+    steps : list[dict]
+        Ordered list of step definitions. Each dict accepts:
+
+        - ``label`` (str): short step name shown in the indicator
+        - ``subtitle`` (str): secondary label shown below
+        - ``icon`` (str): single character/symbol shown in the header (e.g. "◈")
+        - ``fields`` (list[dict]): form fields for this step. Each field::
+
+              {
+                  "key":         str,           # unique key, returned in values
+                  "label":       str,           # display label
+                  "type":        str,           # "text" | "textarea" | "select"
+                  "placeholder": str,           # optional
+                  "required":    bool,          # blocks Next if empty
+                  "options":     list[str],     # required for type="select"
+              }
+
+    orientation : {"horizontal", "vertical"}
+        Layout of the step indicator. "horizontal" shows steps across the top;
+        "vertical" shows a sidebar. Default "horizontal".
+    key : str, optional
+        Streamlit widget key.
+
+    Returns
+    -------
+    dict | None
+        On final submission returns::
+
+            {
+                "step":      int,         # 0-indexed completed step count
+                "values":    dict,        # {field_key: value} for all fields
+                "completed": bool,        # True when user clicks the final button
+            }
+
+        Returns None until completion.
+
+    Example
+    -------
+    >>> from streamlit_stepper import st_stepper
+    >>>
+    >>> steps = [
+    ...     {
+    ...         "label": "Basics", "subtitle": "Name & type", "icon": "◈",
+    ...         "fields": [
+    ...             {"key": "name", "label": "Project name", "type": "text", "required": True},
+    ...             {"key": "type", "label": "Type", "type": "select",
+    ...              "options": ["Web App", "API", "ML Model"], "required": True},
+    ...         ],
+    ...     },
+    ...     {
+    ...         "label": "Review", "subtitle": "Confirm", "icon": "◆",
+    ...         "fields": [],
+    ...     },
+    ... ]
+    >>>
+    >>> result = st_stepper(steps, orientation="horizontal", key="wizard")
+    >>> if result and result["completed"]:
+    ...     st.success(f"Created: {result['values']['name']}")
+    """
+    return _component_func(steps=steps, orientation=orientation, key=key, default=None)

streamlit_stepper-0.1.0/streamlit_stepper/frontend/build/asset-manifest.json

@@ -0,0 +1,10 @@
+{
+  "files": {
+    "main.js": "./static/js/main.4e35496f.js",
+    "index.html": "./index.html",
+    "main.4e35496f.js.map": "./static/js/main.4e35496f.js.map"
+  },
+  "entrypoints": [
+    "static/js/main.4e35496f.js"
+  ]
+}

streamlit_stepper-0.1.0/streamlit_stepper/frontend/build/index.html

@@ -0,0 +1 @@
+<!doctype html><html lang="en"><head><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1"/><title>Streamlit Stepper</title><script defer="defer" src="./static/js/main.4e35496f.js"></script></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div></body></html>