Metadata-Version: 2.1
Name: pytest-workflow
Version: 0.2.0
Summary: A pytest plugin for configuring workflow/pipeline tests using YAML files
Home-page: https://github.com/LUMC/pytest-workflow
Author: Leiden University Medical Center, various departments
Author-email: sasc@lumc.nl
License: AGPL-3.0-or-later
Description: ===============
        pytest-workflow
        ===============
        
        .. Badges have empty alts. So nothing shows up if they do not work.
        .. This fixes readthedocs issues with badges.
        .. image:: https://api.codacy.com/project/badge/Grade/f8bc14b0a507429eac7c06194fafcd59
          :target: https://www.codacy.com/app/LUMC/pytest-workflow?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=LUMC/pytest-workflow&amp;utm_campaign=Badge_Grade
          :alt:
        
        .. image:: https://travis-ci.org/LUMC/pytest-workflow.svg?branch=develop
          :target: https://travis-ci.org/LUMC/pytest-workflow
          :alt:
        
        .. image:: https://codecov.io/gh/LUMC/pytest-workflow/branch/develop/graph/badge.svg
          :target: https://codecov.io/gh/LUMC/pytest-workflow
          :alt:
        
        .. image:: https://img.shields.io/pypi/pyversions/pytest-workflow.svg
          :target: https://pypi.org/project/pytest-workflow/
          :alt:
        
        pytest-workflow is a pytest plugin that aims to make pipeline/workflow testing easy
        by using yaml files for the test configuration.
        
        For our complete documentation checkout our
        `readthedocs page <https://pytest-workflow.readthedocs.io/>`_.
        
        
        Installation
        ============
        Pytest-workflow requires Python 3.5 or higher. It is tested on Python 3.5, 3.6
        and 3.7. Python 2 is not supported.
        
        - Make sure your virtual environment is activated.
        - Install using pip ``pip install pytest-workflow``
        - Create a ``tests`` directory in the root of your repository.
        - Create your test yaml files in the ``tests`` directory.
        
        Quickstart
        ==========
        
        Run ``pytest`` from an environment with pytest-workflow installed.
        Pytest will automatically gather files in the ``tests`` directory starting with
        ``test`` and ending in ``.yaml`` or ``.yml``.
        
        Below is an example of a YAML file that defines a test:
        
        .. code-block:: yaml
        
          - name: Touch a file
            command: touch test.file
            files:
              - path: test.file
        
        This will run ``touch test.file`` and check afterwards if a file with path:
        ``test.file`` is present. It will also check if the ``command`` has exited
        with exit code ``0``, which is the only default test that is run. Testing
        workflows that exit with another exit code is also possible.
        
        Documentation for more advanced use cases can be found on our
        `readthedocs page <https://pytest-workflow.readthedocs.io/>`_.
        
Keywords: pytest workflow pipeline yaml yml
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Framework :: Pytest
Requires-Python: >=3.5
Description-Content-Type: text/x-rst
