1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
|
Overview
========
.. start-badges
.. list-table::
:stub-columns: 1
* - docs
- |docs|
* - tests
- |travis| |appveyor| |requires|
* - package
- |version| |downloads| |wheel| |supported-versions| |supported-implementations|
.. |docs| image:: https://readthedocs.org/projects/pytest-cython/badge/?style=flat
:target: https://readthedocs.org/projects/pytest-cython
:alt: Documentation Status
.. |travis| image:: https://travis-ci.org/lgpage/pytest-cython.svg?branch=master
:alt: Travis-CI Build Status
:target: https://travis-ci.org/lgpage/pytest-cython
.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/github/lgpage/pytest-cython?branch=master&svg=true
:alt: AppVeyor Build Status
:target: https://ci.appveyor.com/project/lgpage/pytest-cython
.. |requires| image:: https://requires.io/github/lgpage/pytest-cython/requirements.svg?branch=master
:alt: Requirements Status
:target: https://requires.io/github/lgpage/pytest-cython/requirements/?branch=master
.. |version| image:: https://img.shields.io/pypi/v/pytest-cython.svg?style=flat
:alt: PyPI Package latest release
:target: https://pypi.python.org/pypi/pytest-cython
.. |downloads| image:: https://img.shields.io/pypi/dm/pytest-cython.svg?style=flat
:alt: PyPI Package monthly downloads
:target: https://pypi.python.org/pypi/pytest-cython
.. |wheel| image:: https://img.shields.io/pypi/wheel/pytest-cython.svg?style=flat
:alt: PyPI Wheel
:target: https://pypi.python.org/pypi/pytest-cython
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/pytest-cython.svg?style=flat
:alt: Supported versions
:target: https://pypi.python.org/pypi/pytest-cython
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/pytest-cython.svg?style=flat
:alt: Supported implementations
:target: https://pypi.python.org/pypi/pytest-cython
.. end-badges
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::
py.test --doctest-cython
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
* The `embedsignature` `Cython compiler directive`_ must be set to `True`
Contributing
============
Contributions are very welcome. Tests can be run with `tox`_::
tox
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.
.. _`Cookiecutter`: https://github.com/audreyr/cookiecutter
.. _`@hackebrot`: https://github.com/hackebrot
.. _`@ionelmc`: https://github.com/ionelmc
.. _`MIT`: http://opensource.org/licenses/MIT
.. _`BSD-3`: http://opensource.org/licenses/BSD-3-Clause
.. _`GNU GPL v3.0`: http://www.gnu.org/licenses/gpl-3.0.txt
.. _`Apache Software License 2.0`: http://www.apache.org/licenses/LICENSE-2.0
.. _`cookiecutter-pytest-plugin`: https://github.com/pytest-dev/cookiecutter-pytest-plugin
.. _`cookiecutter-pylibrary`: https://github.com/ionelmc/cookiecutter-pylibrary
.. _`file an issue`: https://github.com/lgpage/pytest-cython/issues
.. _`pytest`: https://github.com/pytest-dev/pytest
.. _`tox`: https://tox.readthedocs.org/en/latest/
.. _`pip`: https://pypi.python.org/pypi/pip/
.. _`PyPI`: https://pypi.python.org/pypi
.. _`Cython`: http://cython.org/
.. _`Cython compiler directive`: http://docs.cython.org/src/reference/compilation.html#compiler-directives
|