Metadata-Version: 2.1
Name: prospector2html
Version: 1.0.4
Summary: HTML report generator from prospector static analyzer tool output.
Home-page: https://github.com/amdei/prospector-html
Author: amDei the Botan
Author-email: amdeich@gmail.com
Maintainer: Andrey Kulikov
Maintainer-email: amdeich@gmail.com
License: MIT
Keywords: pylint pyflakes pep8 mccabe frosted prospector static code analysis
Platform: any
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Environment :: Console
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Utilities
Classifier: Topic :: Software Development :: Quality Assurance
Description-Content-Type: text/markdown
Requires-Dist: PyYAML
Requires-Dist: json2html

# prospector-html
HTML report generator from [prospector](https://blog.landscape.io/prospector-python-static-analysis-for-humans.html) static analyzer tool JSON output.


## Synopsis
    pip install prospector
    pip install prospector2html
    cd <python-project-sources-dir>
    prospector --no-style-warnings --strictness medium --output-format json > prospector_report.json
    prospector-html --input prospector_report.json
    cat report.html

## Message filtering
 Sometimes it is necessary to filter prospector result by content of the message, 
rather than filter-out the whole error class by it's suppression.
For example prospector would always complains at usage of `_meta` member in Django projects.

 In this case one could fileter such messages by specifing it in prospector-html config file.
`.prospector-html.yaml` by default. See details in the source of sample config or use following example:

    # cat .prospector-html.yaml
    filter:
      message:
          # Filter by exact match
        - "Message to filter"
        - Oter message to filter
      message_re:
          # Regexps to filter
        - 'Exactly one space required after comma.*'
        - 'Exactly one space required before assignment.*'


## TODO
  - ???.


