Metadata-Version: 2.1
Name: enaml-coverage-plugin
Version: 0.2.0
Summary: Coverage plugin for enaml
Author-email: "Matthieu C. Dartiailh" <m.dartiailh@gmail.com>
License: Copyright (c) 2016-2021, Enaml coverage plugin authors
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        
        * Redistributions in binary form must reproduce the above copyright notice,
          this list of conditions and the following disclaimer in the documentation
          and/or other materials provided with the distribution.
        
        * Neither the name of enaml coverage plugin nor the names of its
          contributors may be used to endorse or promote products derived from
          this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: homepage, https://github.com/MatthieuDartiailh/enaml_coverage_plugin
Project-URL: repository, https://github.com/MatthieuDartiailh/enaml_coverage_plugin
Project-URL: changelog, https://github.com/MatthieuDartiailh/enaml_coverage_plugin/blob/main/releasenotes.rst
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS
Requires-Dist: coverage
Requires-Dist: enaml (>=0.16)

Enaml coverage plugin
=====================

.. image:: https://github.com/MatthieuDartiailh/enaml_coverage_plugin/actions/workflows/ci.yml/badge.svg
    :target: https://github.com/MatthieuDartiailh/enaml_coverage_plugin/actions/workflows/ci.yml

Coverage to plugin to provide coverage reports for Enaml files (.enaml).

Usage
-----

To enable the plugin, one simply needs to add the following snippet under the
``run``  section of a project coverage configuration file:

.. code::

    plugins =
        enaml_coverage_plugin

.. note::

    Branch coverage is always on so in order to be able to combine reports, branch
    coverage need to be enabled for Python files. The can be done by specifying
    ``branch=True`` under the ``run`` section of your coverage configuration.
