# Nest UI

**Nest UI** is a terminal UI framework scaffold for building dashboards, launchers, assistant-style tools, and developer utilities in Python.

This release pack is structured so you can publish and maintain the package cleanly on PyPI.

## Install

```bash
pip install nest-ui
```

## Requirements

### Core
- Python **3.8+**
- `colorama>=0.4.6`

### Optional extras

#### Voice features
Use this when you want speech input / assistant-style controls.

```bash
pip install "nest-ui[voice]"
```

Installs:
- `SpeechRecognition>=3.10.0`

Optional on some systems:
- `PyAudio` for microphone capture

#### Ops / monitoring features
Use this when you want process monitoring, service checks, or system helpers.

```bash
pip install "nest-ui[ops]"
```

Installs:
- `psutil>=5.9.0`

#### Clipboard helpers
Use this when you want copy / paste integrations.

```bash
pip install "nest-ui[clipboard]"
```

Installs:
- `pyperclip>=1.8.2`

#### Everything
```bash
pip install "nest-ui[full]"
```

Installs:
- `SpeechRecognition>=3.10.0`
- `psutil>=5.9.0`
- `pyperclip>=1.8.2`

## Quick start

```python
from nest_ui import App

app = App(theme="aurora", icon_pack="emoji")
window = app.create_window("Nest UI", "release-ready package")
main = window.create_section("Overview")

main.add_stat("CPU", "23%", tone="info")
main.add_key_value("Workspace", "default")
main.add_paragraph("Welcome", "Nest UI is ready.")

window.log("INFO", "System initialized")
window.run()
```

## CLI

After installation, you can run:

```bash
nest-ui
```

## What is included in this release pack

- Release-ready `pyproject.toml`
- Package metadata and entry point
- `MANIFEST.in`
- `LICENSE`
- `.gitignore`
- `CHANGELOG.md`
- `CONTRIBUTING.md`
- GitHub Actions for test + publish
- Example app
- Basic tests
- Optional dependency groups

## Recommended release workflow

### Local development
```bash
pip install -e ".[full]"
pytest -q
```

### Build package
```bash
python -m build
twine check dist/*
```

### Publish
```bash
twine upload dist/*
```

## Versioning

- Patch: `1.1.1` -> bug fixes
- Minor: `1.2.0` -> new features
- Major: `2.0.0` -> breaking changes

## Notes

This pack focuses on the release structure and maintainability of Nest UI.  
You can merge these files into your current library and then expand the core modules with your full feature set.
