Metadata-Version: 2.1
Name: annotation-validation
Version: 0.1.0
Summary: Annotation Validation ensures type checking for function annotations.
Home-page: https://github.com/szuckerman/annotation_validation
Author: Sam Zuckerman
Author-email: sam.p.zuckerman@gmail.com
License: MIT license
Keywords: annotation_validation
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7

=====================
Annotation Validation
=====================


.. image:: https://img.shields.io/pypi/v/annotation_validation.svg
        :target: https://pypi.python.org/pypi/annotation_validation

.. image:: https://img.shields.io/travis/szuckerman/annotation_validation.svg
        :target: https://travis-ci.org/szuckerman/annotation_validation

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


.. image:: https://pyup.io/repos/github/szuckerman/annotation_validation/shield.svg
     :target: https://pyup.io/repos/github/szuckerman/annotation_validation/
     :alt: Updates



Annotation Validation ensures type checking for function annotations.


* Free software: MIT license
* Documentation: https://annotation-validation.readthedocs.io.


Features
--------

* Validates input to match data types of annotations of function arguments
* Validates output to match data type of annotation of return argument
* Used as a decorator!

Possible Improvements
---------------------

* Validation of ranges of input
* Throw warnings instead of errors
* Logging

Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

Inspiration is from `this blog post`_.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
.. _this blog post: https://aboutsimon.com/blog/2018/04/04/Python3-Type-Checking-And-Data-Validation-With-Type-Hints.html





=======
History
=======

0.1.0 (2019-02-04)
------------------

* First release on PyPI.


