Metadata-Version: 2.4
Name: klippy-stubs
Version: 0.1.0
Summary: PEP 561 type stubs for Klipper's klippy package
Project-URL: Homepage, https://github.com/charliemayall/klippy-stubs
Project-URL: Repository, https://github.com/charliemayall/klippy-stubs
License-Expression: GPL-3.0-or-later
Classifier: Programming Language :: Python :: 3
Classifier: Typing :: Stubs Only
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# klippy-stubs

PEP 561 type stubs for [Klipper](https://www.klipper3d.org/)'s `klippy` package.

## Install

```bash
uv add klippy-stubs
# or
pip install klippy-stubs
```

Type checkers pick up the stubs automatically after install.

## Development

```bash
uv sync --dev
uv run ty check
uv run python smoke_check.py
```

To verify the installable package (required for mypy):

```bash
uv build
uv pip install dist/klippy_stubs-*.whl --force-reinstall
uv run mypy smoke_check.py
```

## Layout

```
klippy-stubs/     # PEP 561 stub package (ships as site-packages/klippy-stubs/)
typings/          # dev-only stubs for klippy dependencies (cffi, greenlet)
smoke_check.py    # overload regression check (not shipped)
```
