pytest-match-skip 0.0.1

=================
pytest-match-skip
=================

.. image:: https://travis-ci.org/jsfehler/pytest-match-skip.svg?branch=master
:target: https://travis-ci.org/jsfehler/pytest-match-skip
:alt: See Build Status on Travis CI

.. image:: https://ci.appveyor.com/api/projects/status/github/jsfehler/pytest-match-skip?branch=master
:target: https://ci.appveyor.com/project/jsfehler/pytest-match-skip/branch/master
:alt: See Build Status on AppVeyor

Skip matching marks. Matches partial marks using wildcards.

----

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


Features
--------

* Allows any tag to be used for a skip or xfail
* Wildcards can be used for tags with variable parts (ie: Specify bug_.* for bug_123, bug_777)
* Important tags can be specified and the user will be warned when they're skipped
* Tags that should be skipped can be forced to run anyways


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

* TODO


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

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

$ pip install pytest-match-skip


Usage
-----

* The following options can be added to a pytest.ini file:
- skip_marks: List of marks that will be detected
- important_marks: List of marks that will warn the user if skipped
- run_skips: true or false to run tests with a skip mark
- xfail_skips: true or false to xfail instead of skip the marked tests

Example:

.. code-block:: none

[pytest]
skip_marks = bug_.* .*_tracker .*_known_failure_.*
important_marks = smoke .*_sanity important_.*
run_skips = false
xfail_skips = false

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-match-skip" 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/jsfehler/pytest-match-skip/issues
.. _`pytest`: https://github.com/pytest-dev/pytest
.. _`tox`: https://tox.readthedocs.io/en/latest/
.. _`pip`: https://pypi.python.org/pypi/pip/
.. _`PyPI`: https://pypi.python.org/pypi