Quickstart
==========

Requirements
------------

* Python 3.5 or later

Installation
------------

Install from pypi
.................
This will install the latest release from pypi via pip::

$ pip install flask-buzz

Install latest version from github
..................................
If you would like a version other than the latest published on pypi, you may
do so by cloning the git repostiory::

$ git clone https://github.com/dusktreader/flask-buzz.git

Next, checkout the branch or tag that you wish to use::

$ cd flask-buzz
$ git checkout integration

Finally, use poetry to install from the local directory::

$ poetry install

Using
-----
See `examples/basic.py
<https://github.com/dusktreader/flask-buzz/tree/master/examples/basic.py>`_
for an example of how to use this exception package.