Metadata-Version: 1.2
Name: plot-coverage
Version: 0.1.8
Summary: Python package to generate plots from coverage report
Home-page: https://github.com/modasserbillah/plot_coverage
Author: Modasser Billah
Author-email: imtishad@gmail.com
License: BSD license
Description: =============
        plot_coverage
        =============
        
        
        .. image:: https://img.shields.io/pypi/v/plot_coverage.svg
                :target: https://pypi.python.org/pypi/plot_coverage
        
        .. image:: https://img.shields.io/travis/modasserbillah/plot_coverage.svg
                :target: https://travis-ci.com/modasserbillah/plot_coverage
        
        
        
        
        
        Python package to generate plots from coverage report
        
        
        Generate visual plots to demonstrate your code coverage. Interactive plots are opened in the browser immediately
        after running the script. HTML files for the plots are stored alongside the coverage report inside `htmlcov` folder.
        
        Plots are generated using plotly express.
        
        
        Usage
        ------
        * Install using `pip install plot_coverage`
        * From the project root (where htmlcov folder is located), run:
                - `plot_coverage --plot=treemap`
                - `plot_coverage --plot=sunburst`
        
        Example
        -------
        
        Treemap
        ========
        .. image:: treemap.png
           :alt: Treemap of coverage report
           :class: with-shadow
           :scale: 50
        
        Sunburst
        =========
        .. image:: sunburst.png
           :alt: Sunburst of coverage report
           :class: with-shadow
           :scale: 50
        
        Features
        --------
        
        * Generate Treemap plot for showing your coverage report with color sequence based on coverage percentage.
        * Generate Sunburst plot for showing your coverage report with color sequence based on coverage percentage.
        
        Credits
        -------
        
        This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        
        
        * Free software: BSD license
        
        =======
        History
        =======
        
        0.1.0 (2020-06-25)
        ------------------
        
        * First release on PyPI.
        
Keywords: plot_coverage
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
