pytest-flask
============

|PyPI version| |conda-forge version| |Python versions| |ci| |Documentation status|

An extension of `pytest <http://pytest.org/>`__ test runner which
provides a set of useful tools to simplify testing and development
of the Flask extensions and applications.

To view a more detailed list of extension features and examples go to
the `PyPI <https://pypi.python.org/pypi/pytest-flask>`__ overview page or
`package documentation <http://pytest-flask.readthedocs.org/en/latest/>`_.

How to start?
-------------

Define your application fixture in ``conftest.py``:

.. code-block:: python

    from myapp import create_app

    @pytest.fixture
    def app():
        app = create_app()
        return app

Install the extension with dependencies and go::

    $ pip install pytest-flask
    $ pytest

Contributing
------------

Don’t hesitate to create a `GitHub issue <https://github.com/vitalk/pytest-flask/issues>`__ for any bug or
suggestion.

.. |PyPI version| image:: https://img.shields.io/pypi/v/pytest-flask.svg
   :target: https://pypi.python.org/pypi/pytest-flask
   :alt: PyPi version

.. |conda-forge version| image:: https://img.shields.io/conda/vn/conda-forge/pytest-flask.svg
   :target: https://anaconda.org/conda-forge/pytest-flask
   :alt: conda-forge version

.. |ci| image:: https://github.com/pytest-dev/pytest-flask/workflows/build/badge.svg
   :target: https://github.com/pytest-dev/pytest-flask/actions
   :alt: CI status

.. |Python versions| image:: https://img.shields.io/pypi/pyversions/pytest-flask.svg
   :target: https://pypi.org/project/pytest-flask
   :alt: PyPi downloads

.. |Documentation status| image:: https://readthedocs.org/projects/pytest-flask/badge/?version=latest
   :target: https://pytest-flask.readthedocs.org/en/latest/
   :alt: Documentation status
