Skip to main content

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

Project description

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


The RiveScript Coverage Plugin is a plugin for 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 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:

    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.


The full documentation is at


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

Project details

Download files

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

Source Distribution

rivescript_coverage_plugin-0.2.2.tar.gz (18.9 kB view hashes)

Uploaded Source

Built Distributions

rivescript_coverage_plugin-0.2.2-py3.7.egg (15.1 kB view hashes)

Uploaded Source

rivescript_coverage_plugin-0.2.2-py2.py3-none-any.whl (16.5 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page