Metadata-Version: 1.1
Name: etools-validator
Version: 0.2.0
Summary: Django rest framework validation enhancement
Home-page: https://github.com/unicef/etools-validator
Author: UNICEF
Author-email: rapidpro@unicef.org
License: Apache 2 License
Description: Validator
        #########
        
        Validator is a library that provides an improved handling of validation.
        
        The following parts of validation are handled;
        
            - state
            - transistion
        
        
        Installation
        ============
        
        .. code-block:: bash
           pip install etools-validator
        
        
        Setup
        =====
        
        Add ``validator`` to ``INSTALLED_APPS`` in ``settings.py``
        
        .. code-block:: python
           INSTALLED_APPS = [
               ...
               'validator',
           ]
        
        
        Usage
        =====
        
        Use ``validator`` in views
        
        ..  code-block:: python
           from validator.mixins import ValidatorViewMixin
        
           class ExampleView(ValidatorViewMixin, ListCreateAPIView):
               ...
        
        
        Contributing
        ============
        
        Environment Setup
        -----------------
        
        To install the necessary libraries
        
        ::
        
           $ pip install -r requirements/dev.txt
        
        
        Coding Standards
        ----------------
        
        See `PEP 8 Style Guide for Python Code <https://www.python.org/dev/peps/pep-0008/>`_ for complete details on the coding standards.
        
        To run checks on the code to ensure code is in compliance
        
        ::
        
           $ flake8 .
        
        
        Testing
        -------
        
        Testing is important and tests are located in `tests/` directory and can be run with;
        
        ::
        
           $ coverage run manage.py test
        
        Coverage report is viewable in `build/coverage` directory, and can be generated with;
        
        ::
        
           $ coverage html
        
Platform: any
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
