Metadata-Version: 2.1
Name: polarion-docstrings
Version: 0.16.1
Summary: Reads Polarion docstrings and validates them using flake8
Home-page: https://gitlab.com/mkourim/polarion_docstrings
Author: Martin Kourim
Author-email: mkourim@redhat.com
License: MIT
Keywords: polarion,testing
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Testing
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Intended Audience :: Developers
Requires-Dist: pyyaml

polarion-docstrings
===================

.. image:: https://gitlab.com/mkourim/polarion_docstrings/badges/master/pipeline.svg
    :target: https://gitlab.com/mkourim/polarion_docstrings/commits/master
    :alt: pipeline status

.. image:: https://gitlab.com/mkourim/polarion_docstrings/badges/master/coverage.svg
    :target: https://gitlab.com/mkourim/polarion_docstrings/commits/master
    :alt: coverage report

.. image:: https://img.shields.io/pypi/v/polarion-docstrings.svg
    :target: https://pypi.python.org/pypi/polarion-docstrings
    :alt: Version

.. image:: https://img.shields.io/pypi/pyversions/polarion-docstrings.svg
    :target: https://pypi.python.org/pypi/polarion-docstrings
    :alt: Supported Python Versions

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/ambv/black
    :alt: Code style: black

Description
-----------
Library for reading Polarion docstrings used in Insights and CFME QE. Includes a flake8 extension for validating the docstrings.

Install
-------
To install the package to your virtualenv, run

.. code-block::

    pip install polarion-docstrings

or install it from cloned directory

.. code-block::

    pip install -e .

Package on PyPI <https://pypi.python.org/pypi/polarion-docstrings>

