=========================
idem-resources-validation
=========================
.. image:: https://img.shields.io/badge/made%20with-pop-teal
:alt: Made with pop, a Python implementation of Plugin Oriented Programming
:target: https://pop.readthedocs.io/
.. image:: https://img.shields.io/badge/made%20with-idem-teal
:alt: Made with idem, a Python implementation of Plugin Oriented Programming
:target: https://www.idemproject.io/
.. image:: https://img.shields.io/badge/docs%20on-docs.idemproject.io-blue
:alt: Documentation is published with Sphinx on docs.idemproject.io
:target: https://docs.idemproject.io/idem-gcp/en/latest/index.html
.. image:: https://img.shields.io/badge/made%20with-python-yellow
:alt: Made with Python
:target: https://www.python.org/
Resources schemas validation plugin tool.
About
=====
``idem-resources-validation`` performs different validations on the IDEM plugins' schemas using ``idem``.
* `idem-resources-validation source code: <https://gitlab.com/vmware/idem/idem-resources-validation>`__
What is POP?
------------
This project is built with `pop <https://pop.readthedocs.io/>`__, a Python-based
implementation of *Plugin Oriented Programming (POP)*. POP seeks to bring
together concepts and wisdom from the history of computing in new ways to solve
modern computing problems.
For more information:
* `Intro to Plugin Oriented Programming (POP) <https://pop-book.readthedocs.io/en/latest/>`__
* `pop-awesome <https://gitlab.com/saltstack/pop/pop-awesome>`__
* `pop-create <https://gitlab.com/saltstack/pop/pop-create/>`__
What is Idem?
-------------
This project is built with `idem <https://www.idemproject.io/>`__, an idempotent,
imperatively executed, declarative programming language written in Python. This project extends
idem!
For more information:
* `Idem Project Website <https://www.idemproject.io/>`__
* `Idem Project docs portal <https://docs.idemproject.io/>`__
Getting Started
===============
Prerequisites
-------------
* Python 3.7+
* git *(if installing from source, or contributing to the project)*
Installation
------------
.. note::
If wanting to contribute to the project, and setup your local development
environment, see the ``CONTRIBUTING.rst`` document in the source repository
for this project.
If wanting to use ``idem-resources-validation``, you can do so by either
installing from PyPI or from source.
Install from PyPI
+++++++++++++++++
.. code-block:: bash
pip install idem-resources-validation
Install from source
+++++++++++++++++++
Clone the `idem-resources-validation` repository.
.. code:: bash
git clone git@gitlab.com:vmware/idem/idem-resources-validation.git
cd idem-resources-validation
Create a virtual environment, and then activate it:
.. code:: bash
python3 -m venv .venv
source .venv/bin/activate
Install idem-resources-validation and other base requirements:
.. code:: bash
pip3 install -e .
pip3 install -r requirements/base.txt
Install the following packages in order to run the tests:
.. code:: bash
pip3 install -r requirements/py3.10/tests.txt
**NOTE:** Change py3.10 if needed with your Python version. There is support for py3.8, py3.9, py3.10 and py3.11.
Setup
=====
After installation the validations execution module will be accessible to the pop `hub`.
You can provide your custom config file with the specific plugin properties.
Plugin config properties file can be found in the idem-resources-validation repo under tests/plugins dir.
.. code:: bash
export PLUGIN_CONFIG_FILE=./tests/plugins/idem-aws-example.json
idem exec resources_validator.schema.checkers.validate_schema
Raw data
{
"_id": null,
"home_page": "https://docs.idemproject.io",
"name": "idem-resources-validation",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "VMware, Inc.",
"author_email": "idemproject@vmware.com",
"download_url": "https://files.pythonhosted.org/packages/7b/5d/3a14f2549ac6d5660715ebfc8e76431720a2360009922e340c098bb9799f/idem-resources-validation-1.0.0.tar.gz",
"platform": null,
"description": "=========================\nidem-resources-validation\n=========================\n\n.. image:: https://img.shields.io/badge/made%20with-pop-teal\n :alt: Made with pop, a Python implementation of Plugin Oriented Programming\n :target: https://pop.readthedocs.io/\n\n.. image:: https://img.shields.io/badge/made%20with-idem-teal\n :alt: Made with idem, a Python implementation of Plugin Oriented Programming\n :target: https://www.idemproject.io/\n\n.. image:: https://img.shields.io/badge/docs%20on-docs.idemproject.io-blue\n :alt: Documentation is published with Sphinx on docs.idemproject.io\n :target: https://docs.idemproject.io/idem-gcp/en/latest/index.html\n\n.. image:: https://img.shields.io/badge/made%20with-python-yellow\n :alt: Made with Python\n :target: https://www.python.org/\n\nResources schemas validation plugin tool.\n\nAbout\n=====\n\n``idem-resources-validation`` performs different validations on the IDEM plugins' schemas using ``idem``.\n\n* `idem-resources-validation source code: <https://gitlab.com/vmware/idem/idem-resources-validation>`__\n\nWhat is POP?\n------------\n\nThis project is built with `pop <https://pop.readthedocs.io/>`__, a Python-based\nimplementation of *Plugin Oriented Programming (POP)*. POP seeks to bring\ntogether concepts and wisdom from the history of computing in new ways to solve\nmodern computing problems.\n\nFor more information:\n\n* `Intro to Plugin Oriented Programming (POP) <https://pop-book.readthedocs.io/en/latest/>`__\n* `pop-awesome <https://gitlab.com/saltstack/pop/pop-awesome>`__\n* `pop-create <https://gitlab.com/saltstack/pop/pop-create/>`__\n\nWhat is Idem?\n-------------\n\nThis project is built with `idem <https://www.idemproject.io/>`__, an idempotent,\nimperatively executed, declarative programming language written in Python. This project extends\nidem!\n\nFor more information:\n\n* `Idem Project Website <https://www.idemproject.io/>`__\n* `Idem Project docs portal <https://docs.idemproject.io/>`__\n\nGetting Started\n===============\n\nPrerequisites\n-------------\n\n* Python 3.7+\n* git *(if installing from source, or contributing to the project)*\n\nInstallation\n------------\n\n.. note::\n\n If wanting to contribute to the project, and setup your local development\n environment, see the ``CONTRIBUTING.rst`` document in the source repository\n for this project.\n\nIf wanting to use ``idem-resources-validation``, you can do so by either\ninstalling from PyPI or from source.\n\nInstall from PyPI\n+++++++++++++++++\n\n.. code-block:: bash\n\n pip install idem-resources-validation\n\nInstall from source\n+++++++++++++++++++\n\nClone the `idem-resources-validation` repository.\n\n.. code:: bash\n\n git clone git@gitlab.com:vmware/idem/idem-resources-validation.git\n cd idem-resources-validation\n\nCreate a virtual environment, and then activate it:\n\n.. code:: bash\n\n python3 -m venv .venv\n source .venv/bin/activate\n\nInstall idem-resources-validation and other base requirements:\n\n.. code:: bash\n\n pip3 install -e .\n pip3 install -r requirements/base.txt\n\n\nInstall the following packages in order to run the tests:\n\n.. code:: bash\n\n pip3 install -r requirements/py3.10/tests.txt\n\n**NOTE:** Change py3.10 if needed with your Python version. There is support for py3.8, py3.9, py3.10 and py3.11.\n\nSetup\n=====\n\nAfter installation the validations execution module will be accessible to the pop `hub`.\nYou can provide your custom config file with the specific plugin properties.\nPlugin config properties file can be found in the idem-resources-validation repo under tests/plugins dir.\n\n.. code:: bash\n\n export PLUGIN_CONFIG_FILE=./tests/plugins/idem-aws-example.json\n idem exec resources_validator.schema.checkers.validate_schema\n\n\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "Validation tools and tests for IDEM resources",
"version": "1.0.0",
"project_urls": {
"Code": "https://gitlab.com/vmware/idem/idem-resources-validation",
"Homepage": "https://docs.idemproject.io",
"Issue tracker": "https://gitlab.com/vmware/idem/idem-resources-validation/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "pypi",
"digests": {
"blake2b_256": "2ffd7e0f452f8e53ff1e99099052ffe1040321cd03a0b13d2cd44565210e4912",
"md5": "6cf74113fe2bbd103fe2aa30bd053f36",
"sha256": "844bd88ae11d7c14d76873d788e5d7e9de3ab0b617b24f4b198553593fcf3693"
},
"downloads": -1,
"filename": "idem_resources_validation-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6cf74113fe2bbd103fe2aa30bd053f36",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 12379,
"upload_time": "2023-06-21T07:27:30",
"upload_time_iso_8601": "2023-06-21T07:27:30.739952Z",
"url": "https://files.pythonhosted.org/packages/2f/fd/7e0f452f8e53ff1e99099052ffe1040321cd03a0b13d2cd44565210e4912/idem_resources_validation-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "pypi",
"digests": {
"blake2b_256": "7b5d3a14f2549ac6d5660715ebfc8e76431720a2360009922e340c098bb9799f",
"md5": "dd42339768a5bb3dd18239744d3cb136",
"sha256": "6a038681eb896a4ada84daab8d1c619b32125fe90804b882f20337b0203ae0f3"
},
"downloads": -1,
"filename": "idem-resources-validation-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "dd42339768a5bb3dd18239744d3cb136",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 12874,
"upload_time": "2023-06-21T07:27:32",
"upload_time_iso_8601": "2023-06-21T07:27:32.334135Z",
"url": "https://files.pythonhosted.org/packages/7b/5d/3a14f2549ac6d5660715ebfc8e76431720a2360009922e340c098bb9799f/idem-resources-validation-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-21 07:27:32",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "vmware",
"gitlab_project": "idem",
"lcname": "idem-resources-validation"
}
JSON