/pytest-cython

Primary LanguagePythonMIT LicenseMIT

Overview

docs Documentation Status
tests Travis-CI Build Status
package PyPI Package latest release PyPI Package monthly downloads PyPI Wheel Supported versions Supported implementations

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 like:

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

Note

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

License

  • Free software: MIT license

Distributed under the terms of the MIT license, "pytest-cython" is free and open source software

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.