Metadata-Version: 2.4
Name: pytest-testbook
Version: 1.2.5
Summary: A pytest plugin for executing Jupyter Notebooks as tests
Author: Ernesto D. Luzon Jr.
Project-URL: Homepage, https://github.com/ldiary/pytest-testbook
Project-URL: Repository, https://github.com/ldiary/pytest-testbook
Project-URL: Bug Tracker, https://github.com/ldiary/pytest-testbook/issues
Classifier: Framework :: Pytest
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: <3.15,>=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pytest>=5.4.0
Requires-Dist: nbformat
Requires-Dist: jupyter_client
Dynamic: license-file

pytest-testbook
===================================

[![Build Status](https://github.com/ldiary/pytest-testbook/actions/workflows/tests.yml/badge.svg)](https://github.com/ldiary/pytest-testbook/actions/workflows/tests.yml) 
[![See Build Status on AppVeyor](https://ci.appveyor.com/api/projects/status/github/ldiary/pytest-testbook?branch=master)](https://ci.appveyor.com/project/ldiary/pytest-testbook/branch/master)

Enables writing 1) software requirements, 2) manual testing procedure, and 3) test automation code all in one single Jupyter Notebook. This notebook effectively becomes a `Testbook` because `pytest` can recognize the automated tests inside and execute the tests.

----

This `Pytest`_ plugin was generated with `Cookiecutter`_ along with `@hackebrot`_'s `Cookiecutter-pytest-plugin`_ template.


Features
--------

* TODO


Requirements
------------

* Latest version of Python (currently Python 3.5); Sorry, I haven't tested it on Python 2.7 or any other versions.
* Latest version of pytest (currently pytest 2.9)
* Jupyter


Installation
------------

You can install "pytest-testbook" via `pip`_ from `PyPI`_::

    $ pip install pytest-testbook


Usage
-----

* TODO

Contributing
------------
Contributions are very welcome. Tests can be run with `tox`_, please ensure
the coverage at least stays the same before you submit a pull request.

License
-------

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


Issues
------

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

.. _`Cookiecutter`: https://github.com/audreyr/cookiecutter
.. _`@hackebrot`: https://github.com/hackebrot
.. _`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
.. _`file an issue`: https://github.com/ldiary/pytest-testbook/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
