Metadata-Version: 2.1
Name: py-buzz
Version: 3.2.1
Summary: "That's not flying, it's falling with style": Exceptions with extras
License: MIT
Author: Tucker Beck
Author-email: tucker.beck@gmail.com
Requires-Python: >=3.6.2,<4.0.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: dataclasses (>=0.8,<0.9); python_version >= "3.6" and python_version < "3.7"
Description-Content-Type: text/x-rst

.. image::  https://badge.fury.io/py/py-buzz.svg
   :target: https://badge.fury.io/py/py-buzz
   :alt:    Latest Version

.. image::  https://travis-ci.org/dusktreader/py-buzz.svg?branch=integration
   :target: https://travis-ci.org/dusktreader/py-buzz
   :alt:    Build Status

.. image::  https://readthedocs.org/projects/py-buzz/badge/?version=latest
   :target: http://py-buzz.readthedocs.io/en/latest/?badge=latest
   :alt:    Documentation Status

*********
 py-buzz
*********

------------------------------------------------------------------
That's not flying, it's falling with style: Exceptions with extras
------------------------------------------------------------------

py-buzz supplies some useful tools to use with python exceptions as well
as a base Buzz exception class that includes them as classmethods.

py-buzz is fully equipped with exception tools that are written over and over
again in python projects such as:

* checking conditions and raising errors on failure (``require_conditon``)
* checking that values are defined and raising errors if not (``enforce_defined``)
* catching exceptions wrapping them in clearer exception types with better error
  messages (``handle_errors``)
* checking many conditions and reporting which ones failed
  (``check_expressions``)

Buzz can be used as a stand-alone exception class, but it is best used as a
bass class for custom exceptions within a project. This allows the user to
focus on creating a set of Exceptions that provide complete coverage for issues
within their application without having to re-write convenience functions
themselves.

Super-quick Start
-----------------
 - requirements: `python3.6+`
 - install through pip: `$ pip install py-buzz`
 - minimal usage example: `examples/with_buzz_class.py <https://github.com/dusktreader/py-buzz/tree/master/examples/with_buzz_class.py>`_

Documentation
-------------

The complete documentation can be found at the
`py-buzz home page <http://py-buzz.readthedocs.io>`_

