Metadata-Version: 2.4
Name: klippy-stubs
Version: 0.2.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
```

Stubs install under `klippy/` (PEP 561).

Pyright, basedpyright, ty, and mypy
resolve `from klippy.*` imports with no extra configuration.

```python
from klippy.configfile import ConfigWrapper
from klippy.klippy import Printer
from klippy.gcode import GCodeCommand
```

## Development

```bash
uv sync --dev
pre-commit install
uv run ty check smoke_check.py
```

Verify the wheel

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