# Overview
[](https://pypi.org/project/pytest-cython)
[](https://pypi.org/project/pytest-cython)
[](https://pypi.org/project/pytest-cython)
[](https://pypi.org/project/pytest-cython)
[](https://pypi.org/project/pytest-cython)
[](https://anaconda.org/conda-forge/pytest-cython)
[](https://anaconda.org/conda-forge/pytest-cython)
[](https://github.com/lgpage/pytest-cython/actions/workflows/python-check.yml?query=branch%3Amain)
[](https://github.com/lgpage/pytest-cython/actions/workflows/python-test.yml?query=branch%3Amain)
[](https://readthedocs.org/projects/pytest-cython)
This [pytest](https://github.com/pytest-dev/pytest) plugin allows for the doctesting of C extension modules for
Python, specifically created through [cython](https://cython.org/).
## Installation
You can install "pytest-cython" via [pip](https://pypi.org/project/pip/) from [PyPI](https://pypi.org):
``` shell
pip install pytest-cython
```
## Usage
Basic usage:
``` shell
pytest --doctest-cython
```
You can also run the doctests for a single `.pyx` file as such:
``` shell
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.
| Version | Pytest | Cython |
| ------- | ------ | ------- |
| 0.3.x | 8 | 0.29, 3 |
| 0.2.x | 6, 7 | 0.29, 3 |
## Issues
If you encounter any problems, please [file an issue](https://github.com/lgpage/pytest-cython/issues) along with a
detailed description.
## Acknowledgements
This [pytest](https://github.com/pytest-dev/pytest) plugin was generated with
[cookiecutter](https://github.com/cookiecutter/cookiecutter) along with [\@hackebrot](https://github.com/hackebrot)'s
[cookiecutter-pytest-plugin](https://github.com/pytest-dev/cookiecutter-pytest-plugin) and
[\@ionelmc](https://github.com/ionelmc)'s [cookiecutter-pylibrary](https://github.com/ionelmc/cookiecutter-pylibrary)
templates.
Raw data
{
"_id": null,
"home_page": "https://github.com/lgpage/pytest-cython",
"name": "pytest-cython",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "pytest, py.test, cython, doctest",
"author": "Logan Page",
"author_email": "page.lg@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/20/6b/deb78024bd288a911346a1e5729b3c9bd329eb0b0cdaf75ebde6072dee07/pytest-cython-0.3.1.tar.gz",
"platform": null,
"description": "# Overview\n\n[](https://pypi.org/project/pytest-cython)\n[](https://pypi.org/project/pytest-cython)\n[](https://pypi.org/project/pytest-cython)\n[](https://pypi.org/project/pytest-cython)\n[](https://pypi.org/project/pytest-cython)\n[](https://anaconda.org/conda-forge/pytest-cython)\n[](https://anaconda.org/conda-forge/pytest-cython)\n\n[](https://github.com/lgpage/pytest-cython/actions/workflows/python-check.yml?query=branch%3Amain)\n[](https://github.com/lgpage/pytest-cython/actions/workflows/python-test.yml?query=branch%3Amain)\n[](https://readthedocs.org/projects/pytest-cython)\n\nThis [pytest](https://github.com/pytest-dev/pytest) plugin allows for the doctesting of C extension modules for\nPython, specifically created through [cython](https://cython.org/).\n\n## Installation\n\nYou can install \"pytest-cython\" via [pip](https://pypi.org/project/pip/) from [PyPI](https://pypi.org):\n\n``` shell\npip install pytest-cython\n```\n\n## Usage\n\nBasic usage:\n\n``` shell\npytest --doctest-cython\n```\n\nYou can also run the doctests for a single `.pyx` file as such:\n\n``` shell\npytest --doctest-cython path/to/module.pyx\n```\n\n### Note\n\nIt is assumed that the C extension modules have been build in place before running `py.test` and there is a\nmatching Cython `.pyx` file\n\n## Compatibility\n\nThe following table describes the versions of Pytest and Cython the each version of the pytest-cython plugin is\ncompatible with.\n\n| Version | Pytest | Cython |\n| ------- | ------ | ------- |\n| 0.3.x | 8 | 0.29, 3 |\n| 0.2.x | 6, 7 | 0.29, 3 |\n\n## Issues\n\nIf you encounter any problems, please [file an issue](https://github.com/lgpage/pytest-cython/issues) along with a\ndetailed description.\n\n## Acknowledgements\n\nThis [pytest](https://github.com/pytest-dev/pytest) plugin was generated with\n[cookiecutter](https://github.com/cookiecutter/cookiecutter) along with [\\@hackebrot](https://github.com/hackebrot)'s\n[cookiecutter-pytest-plugin](https://github.com/pytest-dev/cookiecutter-pytest-plugin) and\n[\\@ionelmc](https://github.com/ionelmc)'s [cookiecutter-pylibrary](https://github.com/ionelmc/cookiecutter-pylibrary)\ntemplates.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A plugin for testing Cython extension modules",
"version": "0.3.1",
"project_urls": {
"Homepage": "https://github.com/lgpage/pytest-cython"
},
"split_keywords": [
"pytest",
" py.test",
" cython",
" doctest"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "035846441806d60412577affc3f61f09191a6ee2f4ae4068ba189f5c9ed695b0",
"md5": "5f29cb4fe2f5cd0d9e568149eeb47136",
"sha256": "e3fff61549e0e58c4ab6ca3cb0a3999bc1e7b80e8d500912b2d35860b5c1f232"
},
"downloads": -1,
"filename": "pytest_cython-0.3.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "5f29cb4fe2f5cd0d9e568149eeb47136",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 5849,
"upload_time": "2024-04-05T14:23:33",
"upload_time_iso_8601": "2024-04-05T14:23:33.059684Z",
"url": "https://files.pythonhosted.org/packages/03/58/46441806d60412577affc3f61f09191a6ee2f4ae4068ba189f5c9ed695b0/pytest_cython-0.3.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "206bdeb78024bd288a911346a1e5729b3c9bd329eb0b0cdaf75ebde6072dee07",
"md5": "23f8f72dea2206e607adc4bebe6e6c64",
"sha256": "4264474a8a6a2801256ad80f03e96552bd96848ddbcc3f1a7e37d7fa9a494455"
},
"downloads": -1,
"filename": "pytest-cython-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "23f8f72dea2206e607adc4bebe6e6c64",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15503,
"upload_time": "2024-04-05T14:23:34",
"upload_time_iso_8601": "2024-04-05T14:23:34.547675Z",
"url": "https://files.pythonhosted.org/packages/20/6b/deb78024bd288a911346a1e5729b3c9bd329eb0b0cdaf75ebde6072dee07/pytest-cython-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-05 14:23:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lgpage",
"github_project": "pytest-cython",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "pytest-cython"
}
JSON
