semvec/pypi-packages huggingface dataset:
pytest-filter-subpackage 0.2.0
Pytest plugin for filtering based on sub-packages
License: BSD
Requires Python: >=3.8
Keywords: pytest,py.test

========================
pytest-filter-subpackage
========================

.. image:: https://dev.azure.com/astropy-project/pytest-filter-subpackage/_apis/build/status/astropy.pytest-filter-subpackage?branchName=main
   :target: https://dev.azure.com/astropy-project/pytest-filter-subpackage/_build/latest?definitionId=5&branchName=main

This package contains a simple plugin for the `pytest`_ framework that provides a
shortcut to testing all code and documentation for a given sub-package.

.. _pytest: https://pytest.org/en/latest/

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

The ``pytest-filter-subpackage`` plugin can be installed using ``pip``::

    $ pip install pytest-filter-subpackage

It is also possible to install the latest development version from the source
repository::

    $ git clone https://github.com/astropy/pytest-filter-subpackage
    $ cd pytest-filter-subpackage
    $ pip install .

In either case, the plugin will automatically be registered for use with
``pytest``.

Usage
-----

This plugin provides a ``-P`` option which takes a comma-separated list
of sub-package names (without the top-level package name)::

    pytest -P wcs,io.fits

which is equivalent to::

    pytest **/wcs **/io/fits

When used in conjunction with `pytest-doctestplus
<http://github.com/astropy/pytest-doctestplus>`_ this will result in both
the narrative documentation and code being tested for a given sub-package.

License
-------
This plugin is licensed under a 3-clause BSD style license - see the
``LICENSE.rst`` file.