# Upstream Compatibility Report

`InquirerPrompt` is the community-maintained fork of [kazhala/InquirerPy](https://github.com/kazhala/InquirerPy).
The import name (`import InquirerPy`) and all public APIs are preserved for full drop-in compatibility.

## Quick Summary

| | Value |
|---|---|
| **Upstream package** | `kazhala/InquirerPy` (`InquirerPy 0.3.4`, last release Nov 2022) |
| **This fork** | `tobiashochguertel/InquirerPy` (`InquirerPrompt`) |
| **Import name** | `import InquirerPy` (unchanged) |
| **API compatibility** | ✅ Full backwards-compatible with upstream 0.3.4 |
| **Report generated by** | [`griffe`](https://mkdocstrings.github.io/griffe/) — Python API introspection tool |

## Install

```sh
# Drop-in replacement — just change the install name:
pip install InquirerPrompt   # was: pip install InquirerPy

# Your imports stay exactly the same:
from InquirerPy import prompt, inquirer
```

## Auto-Generated API Diff

The compatibility report below is generated automatically by the
[Compatibility Check workflow](https://github.com/tobiashochguertel/InquirerPy/actions/workflows/compat.yml)
on every push to `master`. It uses [`griffe`](https://mkdocstrings.github.io/griffe/) to compare
the public API surface of this fork against the upstream `InquirerPy 0.3.4` release.

```{note}
The report file `docs/pages/compat_report.md` is auto-committed by CI after each run.
If you are reading this on ReadTheDocs, the data below reflects the latest `master` state.
```

```{include} compat_report.md
```