Metadata-Version: 1.1
Name: coverage-badge
Version: 1.0.0
Summary: Generate coverage badges for Coverage.py.
Home-page: https://github.com/dbrgn/coverage-badge
Author: Danilo Bargen
Author-email: mail@dbrgn.ch
License: MIT
Description: Coverage.py Badge
        ==================
        
        .. image:: https://img.shields.io/travis/dbrgn/coverage-badge/master.svg
            :alt: Build status
            :target: https://travis-ci.org/dbrgn/coverage-badge
        
        .. image:: https://img.shields.io/pypi/dm/coverage-badge.svg
            :alt: PyPI Downloads
            :target: https://pypi.python.org/pypi/coverage-badge
        
        A small script to generate coverage badges using Coverage.py. Example of a generated badge:
        
        .. image:: https://cdn.rawgit.com/dbrgn/coverage-badge/master/example.svg
            :alt: Example coverage badge
        
        The badge template has been taken from shields.io_, therefore it should look
        mostly good. (The spec is a bit stricter on the margins, but I can't easily do
        text width calculations in Python so the margins might not always be 4px.)
        
        .. _shields.io: http://shields.io/
        
        
        Usage
        -----
        
        First, run Coverage.py to generate the necessary coverage data. Then you can
        either return the badge SVG to stdout::
        
            $ coverage-badge
        
        ...or write it to a file::
        
            $ coverage-badge -o coverage.svg
        
        It's important that you run ``coverage-badge`` from the directory where the
        ``.coverage`` data file is located.
        
        Different colors for cover ranges:
        
        .. image:: https://cdn.rawgit.com/samael500/coverage-badge/master/media/15.svg
            :alt: 15%
        
        .. image:: https://cdn.rawgit.com/samael500/coverage-badge/master/media/45.svg
            :alt: 45%
        
        .. image:: https://cdn.rawgit.com/samael500/coverage-badge/master/media/65.svg
            :alt: 65%
        
        .. image:: https://cdn.rawgit.com/samael500/coverage-badge/master/media/80.svg
            :alt: 80%
        
        .. image:: https://cdn.rawgit.com/samael500/coverage-badge/master/media/93.svg
            :alt: 93%
        
        .. image:: https://cdn.rawgit.com/samael500/coverage-badge/master/media/97.svg
            :alt: 97%
        
        ---
        
        The full usage text::
        
            usage: __main__.py [-h] [-o FILEPATH] [-p] [-f] [-q] [-v]
        
            Generate coverage badges for Coverage.py.
        
            optional arguments:
              -h, --help   show this help message and exit
              -o FILEPATH  Save the file to the specified path.
              -p           Plain color mode. Standard green badge.
              -f           Force overwrite image, use with -o key.
              -q           Don't output any non-error messages.
              -v           Show version.
        
        License
        -------
        
        MIT License, see `LICENSE.txt` file..
        
Keywords: coverage badge shield
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Testing
