Metadata-Version: 1.1
Name: django-coverage-plugin
Version: 1.6.0
Summary: Django template coverage.py plugin
Home-page: https://github.com/nedbat/django_coverage_plugin
Author: Ned Batchelder
Author-email: ned@nedbatchelder.com
License: Apache 2.0
Description: 
        
        ==================================
        Django Template Coverage.py Plugin
        ==================================
        
        A `coverage.py`_ plugin to measure test coverage of Django templates.
        
        Supported Python versions: 2.7, 3.4, 3.5 and 3.6.
        
        Supported Django versions: 1.8, 1.11, 2.0, and 2.1.
        
        Supported coverage.py versions are 4.0 and higher.
        
        The plugin is pip installable::
        
            $ pip install django_coverage_plugin
        
        To run it, add this setting to your ``.coveragerc`` file::
        
            [run]
            plugins =
                django_coverage_plugin
        
        Then run your tests under `coverage.py`_.
        
        You will see your templates listed in your coverage report along with
        your Python modules. Please use `coverage.py`_ v4.4 or greater to allow
        the plugin to identify untested templates.
        
        If you get a :code:`django.core.exceptions.ImproperlyConfigured` error,
        you need to set the :code:`DJANGO_SETTINGS_MODULE` environment variable.
        
        
        Configuration
        ~~~~~~~~~~~~~
        
        The Django template plugin uses some existing settings from your
        .coveragerc file.  The ``source=``, ``include=``, and ``omit=`` options
        control what template files are included in the report.
        
        
        Caveats
        ~~~~~~~
        
        Coverage.py can't tell whether a ``{% blocktrans %}`` tag used the
        singular or plural text, so both are marked as used if the tag is used.
        
        
        What the? How?
        ~~~~~~~~~~~~~~
        
        The technique used to measure the coverage is the same that Dmitry
        Trofimov used in `dtcov`_, but integrated into coverage.py as a plugin,
        and made more performant. I'd love to see how well it works in a real
        production project. If you want to help me with it, feel free to drop me
        an email.
        
        The coverage.py plugin mechanism is designed to be generally useful for
        hooking into the collection and reporting phases of coverage.py,
        specifically to support non-Python files.  If you have non-Python files
        you'd like to support in coverage.py, let's talk.
        
        
        Tests
        ~~~~~
        
        To run the tests::
        
            $ pip install -r requirements.txt
            $ tox
        
        .. _coverage.py: http://nedbatchelder.com/code/coverage
        .. _dtcov: https://github.com/traff/dtcov
        
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Testing
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
