Overview

This pytest plugin allows for the doctesting of C extension modules for Python, specifically created through cython.

Installation

You can install "pytest-cython" via pip from PyPI:

pip install pytest-cython

Usage

Basic usage:

pytest --doctest-cython

You can also run the doctests for a single .pyx file as such:

pytest --doctest-cython path/to/module.pyx

Note

It is assumed that the C extension modules have been build in place before running py.test and there is a matching Cython .pyx file

Compatibility

The following table describes the versions of Pytest and Cython the each version of the pytest-cython plugin is compatible with.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Acknowledgements

This pytest plugin was generated with cookiecutter along with @hackebrot's cookiecutter-pytest-plugin and @ionelmc's cookiecutter-pylibrary templates.