Metadata-Version: 2.1
Name: im-openapi-validator
Version: 1.0.1
Summary: The IM OpenAPI Validator
Home-page: https://github.com/informaticsmatters/openapi-validator
Author: Alan Christie
Author-email: achristie@informaticsmatters.com
License: MIT
Keywords: configuration
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: System :: Installation/Setup
Classifier: Operating System :: POSIX :: Linux
License-File: LICENSE

Informatics Matters OpenAPI Validator (oval)
============================================

.. image:: https://badge.fury.io/py/im-openapi-validator.svg
   :target: https://badge.fury.io/py/im-openapi-validator
   :alt: PyPI package (latest)

.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
   :target: https://github.com/pre-commit/pre-commit
   :alt: pre-commit

A utility designed as a `pre-commit`_ OpenAPI file validator::

    oval --help

Use it by adding it to your repository's ``.pre-commit-config.yaml`` file::

    # Basic OpenAPI Validator
    - repo: https://github.com/informaticsmatters/openapi-validator
      rev: '1.0.0'
      hooks:
      - id: im-oval
        files: app/openapi/openapi.yaml

.. _pre-commit: https://pre-commit.com

Installation
============

The OpenAPI validator is published on `PyPI`_ and can be installed from there::

    pip install im-openapi-validator

This is a Python 3 utility, so try to run it from a recent (ideally 3.10)
Python environment.

.. _PyPI: https://pypi.org/project/im-openapi-validator/

Get in touch
------------

- Report bugs, suggest features or view the source code `on GitHub`_.

.. _on GitHub: https://github.com/informaticsmatters/openapi-validator
