Metadata-Version: 2.4
Name: sheafmodal
Version: 0.0.1a1
Summary: Bootstrap modal flow helpers for the SheafLab project.
Project-URL: Homepage, https://sheaflab.com
Project-URL: Repository, https://github.com/SheafLab/sheafmodal-python
Project-URL: Issues, https://github.com/SheafLab/sheafmodal-python/issues
Author: SheafLab
License: MIT
License-File: LICENSE
Keywords: flow,modal,sheaflab,state,steps
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# sheafmodal

`sheafmodal` is the official Python package namespace for lightweight modal and
step-flow state helpers used by the SheafLab project.

This initial public release offers a small but real surface: defining modal
steps, tracking an active step, filling required fields, and validating whether
a flow can advance or retreat.

## Install

```bash
pip install sheafmodal
```

## Usage

```python
from sheafmodal import ModalStep, advance, create_state, fill_fields

steps = (
    ModalStep("details", "Details", ("title",)),
    ModalStep("review", "Review"),
)

state = create_state(steps)
state = fill_fields(state, title="Example")
state = advance(state)
```

## Status

- Project stage: pre-alpha
- Package scope: bootstrap modal-state utilities only
- Main project site: https://sheaflab.com

