Metadata-Version: 2.4
Name: flask-buzz
Version: 4.0.0
Summary: Extra bindings on py-buzz specifically for flask apps
Project-URL: homepage, https://github.com/dusktreader/flask-buzz
Project-URL: source, https://github.com/dusktreader/flask-buzz
Project-URL: changelog, https://github.com/dusktreader/flask-buzz/blob/main/CHANGELOG.md
Author-email: Tucker Beck <tucker.beck@gmail.com>
License-File: LICENSE.md
Requires-Python: >=3.10
Requires-Dist: flask<4.0,>=2.0
Requires-Dist: py-buzz~=7.0
Description-Content-Type: text/markdown

[![PyPI Versions](https://img.shields.io/pypi/v/flask-buzz?style=plastic&label=pypi-version)](https://img.shields.io/pypi/v/flask-buzz?style=plastic&label=pypi-version)
[![Build Status](https://github.com/dusktreader/flask-buzz/actions/workflows/push.yaml/badge.svg)](https://github.com/dusktreader/flask-buzz/actions/workflows/push.yaml)
![Documentation Status](https://github.com/dusktreader/flask-buzz/actions/workflows/docs.yml/badge.svg)

# flask-buzz

_py-buzz bindings specifically for flask applications_

This is an extension of the [py-buzz](https://github.com/dusktreader/py-buzz) package.

It adds extra functionality especially for flask. Predominately, it adds the ability to register an error handler with
Flask that will automatically package any handled `FlaskBuzz` exceptions in a nicely formatted JSON response with the
appropriate `status_code` and message. There is also a method to explicitly `jsonify` a FlaskBuzz error with some
control over what is included in the error body.

## Super-quick Start

Requires: Python 3.10 to 3.13

Install through pip:

```bash
pip install flask-buzz
```

Minimal usage example: [examples/basic.py](https://github.com/dusktreader/flask-buzz/tree/master/examples/basic.py)


## Documentation

The complete documentation can be found at the
[flask-buzz home page](https://github.dusktreader.io/flask-buzz)
