Skip to main content

A plug-in to measure code coverage in RiveScript with python

Project description

https://badge.fury.io/py/rivescript_coverage_plugin.png https://travis-ci.org/snoopyjc/rivescript_coverage_plugin.png?branch=master

A plug-in to measure code coverage in RiveScript with python

Features

The RiveScript Coverage Plugin is a plugin for Coverage.py which extends that package to measure code coverage for RiveScript files. It uses code analysis tools and debug hooks provided by the RiveScript interpreter to determine which lines are executable, and which have been executed. It supports CPython version 3.6 and above and plugs into Coverage.py version 5.0 and above. It requires RiveScript 1.14.9 or above.

Documentation is on Read The Docs. Code repository and issue tracker are on GitHub.

Getting Started

  1. Use pip to install:

    $ pip install rivescript_coverage_plugin
    
  2. Create or edit your .coveragerc file and add this:

    [run]
    plugins = rivescript_coverage_plugin
    
  3. Run the coverage command or pytest with the --cov option and your RiveScript files will automatically be included in the coverage analysis and subsequent report generation.

Note that just like with Python coverage, RiveScript files that are not executed at all will not be part of your coverage report. To add them, use the source = . or other more specific source specifier in the [run] section of your .coveragerc file or the --source command line option. See the Coverage Documentation section “Specifying source files” for more information on this.

Documentation

The full documentation is at http://rivescript_coverage_plugin.rtfd.org.

History

0.1.0 (2020-01-16)

  • First release on PyPI.

0.2.0 (2020-01-17)

  • Fix Issues #1-#4

0.2.1 (2020-01-19)

  • Fix Issue #5

0.2.2 (2020-01-19)

  • Fix Issue #6

0.2.3 (2020-02-23)

  • Fix Issue #7, #8

1.0.0 (2020-02-28)

  • Add syntax highlighting, fixup some documentation issues, and fix issues #9-#14.

1.1.0 (2020-03-29)

  • Fix issues #15-#18 and #21.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for rivescript-coverage-plugin, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size rivescript_coverage_plugin-1.1.0-py2.py3-none-any.whl (21.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size rivescript_coverage_plugin-1.1.0-py3.7.egg (19.6 kB) File type Egg Python version 3.7 Upload date Hashes View
Filename, size rivescript_coverage_plugin-1.1.0.tar.gz (24.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page