Metadata-Version: 2.3
Name: richapi
Version: 0.2.1
Summary: Find HTTPExceptions and turn them into documented responses!
Project-URL: repository, https://github.com/ManiMozaffar/richapi
Project-URL: Homepage, https://github.com/ManiMozaffar/richapi
Project-URL: Documentation, https://github.com/ManiMozaffar/richapi
Project-URL: Source, https://github.com/ManiMozaffar/richapi
License-Expression: MIT
Requires-Python: >=3.9
Requires-Dist: fastapi>=0.105
Requires-Dist: typer>=0.12
Description-Content-Type: text/markdown

### Installation

To install the package, run the following command:

```bash
pip install richapi
```

## Help

See [documentation](https://manimozaffar.github.io/richapi/latest/) for more details.

### Use Cases

RichAPI is designed to simplify FastAPI projects by automatically generating documented HTTP responses from HTTPException without extra effort! 🎉

This project is inspired and completer version of [Kludex's Fast-Response project](https://github.com/Kludex/fastapi-responses)
This package is planned to have more features for now that might be essential for any FastAPI project later.

What would you see WITHOUT RichAPI:
![Screenshot](docs/images/without-richapi.png)

After compiling OpenAPI WITH RichAPI (extended with all possible exceptions coming from your router):
![Screenshot](docs/images/with-richapi.png)
