Metadata-Version: 2.4
Name: pytest-awaiting-fix
Version: 1.0
Summary: A simple plugin to use with pytest for traceability across Jira and disabled automated tests
Author-email: Kie Baker <kiebakerr@proton.me>
Maintainer-email: Kie Baker <kiebakerr@proton.me>
License: 
        The MIT License (MIT)
        
        Copyright (c) 2025 Kie Baker
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
        THE SOFTWARE.
        
Project-URL: Repository, https://github.com/kiebak3r/pytest-awaiting-fix
Classifier: Framework :: Pytest
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Testing
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: pytest>=6.2.0
Requires-Dist: jira>=3.8.0
Dynamic: license-file

===================
pytest-awaiting-fix
===================

.. image:: https://img.shields.io/pypi/v/pytest-awaiting-fix.svg
    :target: https://pypi.org/project/pytest-awaiting-fix
    :alt: PyPI version

.. image:: https://img.shields.io/pypi/pyversions/pytest-awaiting-fix.svg
    :target: https://pypi.org/project/pytest-awaiting-fix
    :alt: Python versions

.. image:: https://github.com/kiebak3r/pytest-awaiting-fix/actions/workflows/main.yml/badge.svg
    :target: https://github.com/kiebak3r/pytest-awaiting-fix/actions/workflows/main.yml
    :alt: See Build Status on GitHub Actions

A simple plugin to use with pytest which helps retain traceability between automated tests and Jira statuses.
When a test is tagged with the @pytest.mark.awaiting_fix('test') decorator it will automatically skip this test
and check the current status of the test in Jira statuses, if the status has progressed to a status the user can
define, it will comment a list of all tests containing the decorator with the associated bug number onto the ticket
so testers will know to also verify the automated tests are re-enabled and passing.

----

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


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

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

    $ pip install pytest-awaiting-fix


Usage
-----
Once the package has been installed:
Tag any tests with the provided decorator pytest.mark.awaiting_fix('test-123')


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-awaiting-fix" 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`: https://opensource.org/licenses/MIT
.. _`BSD-3`: https://opensource.org/licenses/BSD-3-Clause
.. _`GNU GPL v3.0`: https://www.gnu.org/licenses/gpl-3.0.txt
.. _`Apache Software License 2.0`: https://www.apache.org/licenses/LICENSE-2.0
.. _`cookiecutter-pytest-plugin`: https://github.com/pytest-dev/cookiecutter-pytest-plugin
.. _`file an issue`: https://github.com/kiebak3r/pytest-awaiting-fix/issues
.. _`pytest`: https://github.com/pytest-dev/pytest
.. _`tox`: https://tox.readthedocs.io/en/latest/
.. _`pip`: https://pypi.org/project/pip/
.. _`PyPI`: https://pypi.org/project
