Metadata-Version: 1.2
Name: pytest-libiio
Version: 0.0.6
Summary: A pytest plugin to manage interfacing with libiio contexts
Home-page: https://github.com/tfcollins/pytest-libiio
Author: Travis F. Collins
Author-email: travis.collins@analog.com
Maintainer: Travis F. Collins
Maintainer-email: travis.collins@analog.com
License: BSD-3
Description: =============
        pytest-libiio
        =============
        
        .. image:: https://img.shields.io/pypi/v/pytest-libiio.svg
            :target: https://pypi.org/project/pytest-libiio
            :alt: PyPI version
        
        .. image:: https://img.shields.io/pypi/pyversions/pytest-libiio.svg
            :target: https://pypi.org/project/pytest-libiio
            :alt: Python versions
        
        .. image:: https://travis-ci.org/tfcollins/pytest-libiio.svg?branch=master
            :target: https://travis-ci.org/tfcollins/pytest-libiio
            :alt: See Build Status on Travis CI
        
        .. image:: https://coveralls.io/repos/github/tfcollins/pytest-libiio/badge.svg?branch=master
            :target: https://coveralls.io/github/tfcollins/pytest-libiio?branch=master
            :alt: See Coverage Status on Coveralls
        
        .. image:: https://readthedocs.org/projects/pytest-libiio/badge/?version=latest
            :target: https://pytest-libiio.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
        
        A pytest plugin to manage interfacing with libiio contexts
        
        ----
        
        pytest-libiio is pytest plugin to manage interfacing with libiio contexts. This plugin is handy for leveraging the (new) zeroconf features of libiio to find, filter, and map libiio contexts to tests. It was created for `pyadi-iio <https://pypi.org/project/pyadi-iio/>`_ testing but is used in other applications that need an organized way to handle libiio contexts without hardcoding URIs or lots of boilerplate code.
        
        
        Requirements
        ------------
        
        * libiio and pylibiio
        * pytest
        * pyyaml
        
        For development the following are also needed:
        
        * tox
        * pytest-mock
        * pre-commit
        * isort
        * flake8
        * codespell
        * black
        
        
        Installation
        ------------
        
        You can install "pytest-libiio" via `pip`_ from `PyPI`_::
        
            $ pip install pytest-libiio
        
        
        Usage
        -----
        
        This plugin is used to make the access of libiio contexts easier and to provide a unified API through fixtures.
        
        Accessing contexts
        ^^^^^^^^^^^^^^^^^^
        
        Get list of context descriptions of all found contained
        
        .. code-block:: python
        
          import pytest
          import iio
        
        
          def test_libiio_device(context_desc):
              hardware = ["pluto", "adrv9361", "fmcomms2"]
              for ctx_desc in context_desc:
                  if ctx_desc["hw"] in hardware:
                      ctx = iio.Context(ctx_desc["uri"])
              if not ctx:
                  pytest.skip("No required hardware found")
        
        Require certain hardware through marks
        
        .. code-block:: python
        
          import pytest
          import iio
        
        
          @pytest.mark.iio_hardware("adrv9361")
          def test_libiio_device(context_desc):
              for ctx_desc in context_desc:
                  ctx = iio.Context(ctx_desc["uri"])
                  ...
        
        Future ideas
        ------------
        Mock testing is common with libiio's python library since hardware is needed otherwise. In future releases we hope to extend features in pytest-mock through this plugin to make mocking libiio more streamlined.
        
        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 `BSD-3`_ license, "pytest-libiio" 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/tfcollins/pytest-libiio/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
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Pytest
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Testing
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: BSD License
Requires-Python: >=3.5
