{ "info": { "author": "Robin Schneider", "author_email": "ypid@riseup.net", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Intended Audience :: Developers", "Intended Audience :: System Administrators", "License :: DFSG approved", "License :: OSI Approved :: GNU Affero General Public License v3", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Software Development :: Documentation", "Topic :: Software Development :: Quality Assurance", "Topic :: Text Processing" ], "description": "yaml4rst introduction\n=====================\n\n| |Build Status| |Read The Docs| |CII Best Practices| |Code Coverage Status|\n| |Version| |License| |Python versions| |dev status| |pypi monthly downloads|\n\nyaml4rst is a linting/checking/reformatting tool for YAML files documented with\ninline RST which goes hand in hand with yaml2rst_.\n\nIt has been written to help with keeping the ``defaults/main.yml`` file in\nAnsible roles of DebOps_ up-to-date and to assist with writing or\nincluding new roles. DebOps uses Sphinx to generate Ansible role documentation\nwhich also includes the default role variables. Refer to `debops/docs`_ for\ndetails.\n\nUsage\n-----\n\nThe typical use case for this program is to improve the defaults YAML file of\nAnsible roles.\n\nThe recommended way to do this is to commit all your changes in the repository\nof the role, then run:\n\n.. code-block:: bash\n\n yaml4rst -e 'ansible_full_role_name=ROLE_OWNER.ROLE_NAME' defaults/main.yml -i\n\nfrom the root of the role repository. Be sure to replace\n``ROLE_OWNER.ROLE_NAME`` with the particular Ansible role name.\n\nThis will check and reformat the ``defaults/main.yml`` file in place.\n\nNow you can check the reformatted file with a diffing/editing tool of your choosing\nand fix any warning which ``yaml4rst`` might have emitted.\n\nRefer to ``input_files`` and ``output_files`` in the `tests directory`_ for\nautomatically tested examples of input and output files.\n\nNote that for continues usage yaml4rst is invoked from debops-optimize_ when\nyaml4rst is installed so you might want to try debops-optimize_.\n\nFeatures\n--------\n\n.. Redundant. Places: /README.rst and /yaml4rst/reformatter.py\n\nChecks for:\n\n* Reasonable variable namespace\n* Undocumented variables\n\nAutomatically fixes:\n\n* RST sections which are not folds\n* Undocumented variables (adds a FIXME for the user)\n* Documented variables which are not folds\n* YAML documents without a defined header\n* Spacing between variables and sections\n\nKnown limitations\n-----------------\n\n* Does not handle folds with implicit level and missing closing fold marker.\n\n Status: Should be doable but currently not needed nor implemented. A\n ``NotImplementedError`` exception is thrown which causes the CLI program to\n terminate immediately with an error and reference to this section.\n\n As workaround just strip out the opening folds with your favorite editor as\n ``yaml4rst`` will add missing folds for sections and variables anyway.\n Refer to the Makefile_ (``prepare-real-data`` target) where such a workaround\n is used for integration testing. Note that this is not perfect as can be seen\n on the ``debops.apt_install`` test case.\n\nRepository\n----------\n\n* `GitHub `_ (primary repo with issue tracker)\n\nDocumentation\n-------------\n\n* `Read the Docs `_\n\nAuthors\n-------\n\n* `Robin Schneider `_\n\nLicense\n-------\n\n`GNU Affero General Public License v3 (AGPL-3.0)`_\n\n.. _GNU Affero General Public License v3 (AGPL-3.0): https://tldrlegal.com/license/gnu-affero-general-public-license-v3-%28agpl-3.0%29\n.. _DebOps: https://debops.org/\n.. _debops/docs: https://github.com/debops/docs/\n.. _yaml2rst: https://github.com/htgoebel/yaml2rst\n.. _Makefile: https://github.com/ypid/yaml4rst/blob/master/Makefile\n.. _tests directory: https://github.com/ypid/yaml4rst/tree/master/tests\n.. _debops-optimize: https://github.com/ypid/ypid-ansible-common/blob/master/bin/debops-optimize\n\n.. |Build Status| image:: https://travis-ci.org/ypid/yaml4rst.svg\n :target: https://travis-ci.org/ypid/yaml4rst\n\n.. |Read the Docs| image:: https://readthedocs.org/projects/yaml4rst/badge/?version=latest\n :target: https://yaml4rst.readthedocs.io/en/latest/\n\n.. |CII Best Practices| image:: https://bestpractices.coreinfrastructure.org/projects/457/badge\n :target: https://bestpractices.coreinfrastructure.org/projects/457\n\n.. No need to register at https://coveralls.io or something. 100% is just enforced in the CI build.\n.. |Code Coverage Status| image:: https://img.shields.io/badge/coverage-100%-brightgreen.svg\n :target: https://travis-ci.org/ypid/yaml4rst\n\n.. |Version| image:: https://img.shields.io/pypi/v/yaml4rst.svg\n :target: https://pypi.python.org/pypi/yaml4rst\n\n.. |License| image:: https://img.shields.io/pypi/l/yaml4rst.svg\n :target: https://pypi.python.org/pypi/yaml4rst\n\n.. |Python versions| image:: https://img.shields.io/pypi/pyversions/yaml4rst.svg\n :target: https://pypi.python.org/pypi/yaml4rst\n\n.. |dev status| image:: https://img.shields.io/pypi/status/yaml4rst.svg\n :target: https://pypi.python.org/pypi/yaml4rst\n\n.. |pypi monthly downloads| image:: https://img.shields.io/pypi/dm/yaml4rst.svg\n :target: https://pypi.python.org/pypi/yaml4rst", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/ypid/yaml4rst", "keywords": "YML YAML RST reStructuresText Ansible DebOps linting docs documentation", "license": "AGPL-3.0", "maintainer": "", "maintainer_email": "", "name": "yaml4rst", "package_url": "https://pypi.org/project/yaml4rst/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/yaml4rst/", "project_urls": { "Homepage": "https://github.com/ypid/yaml4rst" }, "release_url": "https://pypi.org/project/yaml4rst/0.1.6/", "requires_dist": [ "PyYAML", "Jinja2", "nose; extra == 'test'", "nose2; extra == 'test'", "testfixtures; extra == 'test'", "tox; extra == 'test'", "flake8; extra == 'test'", "pylint; extra == 'test'", "coverage; extra == 'test'", "yamllint; extra == 'test'" ], "requires_python": "", "summary": "Linting/reformatting tool for YAML files documented with inline RST", "version": "0.1.6" }, "last_serial": 2838999, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "150d985a6a2d5181d0c868128ecba62a", "sha256": "bf32ae436b5f2a727340082b45046cc61a1ac3b8943901750d3ac3ebeba302c1" }, "downloads": -1, "filename": "yaml4rst-0.1.0-py3-none-any.whl", "has_sig": true, "md5_digest": "150d985a6a2d5181d0c868128ecba62a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 26737, "upload_time": "2016-10-28T10:05:46", "url": "https://files.pythonhosted.org/packages/f1/a9/55a137c0eda9368f3b9a8fa001bed06e70f0b27e3a140b2babcd76eb7b74/yaml4rst-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b88090be8396e629e07d0b7e54c7b493", "sha256": "78f5ca0b36e0bac94d702c0abd644d78482be9ae37b32b35b36d0eae92ac9716" }, "downloads": -1, "filename": "yaml4rst-0.1.0.tar.gz", "has_sig": true, "md5_digest": "b88090be8396e629e07d0b7e54c7b493", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 100849, "upload_time": "2016-10-28T10:05:49", "url": "https://files.pythonhosted.org/packages/0a/b3/ccb1a2ce218a439f412af4a9b21b81eb0e10911d1a9421b6eb7a5cdca254/yaml4rst-0.1.0.tar.gz" } ], "0.1.0.dev0": [ { "comment_text": "", "digests": { "md5": "0ebfd0c9fd59c645791fcdea64f20cc6", "sha256": "ca92607e1ea2eda3bb3878b6457a0b56bfbf0a83df9ac0c2ba22d0458148dc45" }, "downloads": -1, "filename": "yaml4rst-0.1.0.dev0-py3-none-any.whl", "has_sig": true, "md5_digest": "0ebfd0c9fd59c645791fcdea64f20cc6", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 25910, "upload_time": "2016-10-22T14:57:49", "url": "https://files.pythonhosted.org/packages/a8/8f/2f92d8d127791cdcfdff86212db80cda5062c33088bc0316f759b779c908/yaml4rst-0.1.0.dev0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "eb7da306cfbe5617d9b5307aaf64db19", "sha256": "37f3dbfbf54023fd1ac10590df55927a932654b738080c56ebf5eff1c2628978" }, "downloads": -1, "filename": "yaml4rst-0.1.0.dev0.tar.gz", "has_sig": true, "md5_digest": "eb7da306cfbe5617d9b5307aaf64db19", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 90321, "upload_time": "2016-10-22T14:57:52", "url": "https://files.pythonhosted.org/packages/f5/6b/8d096df0cf00c9c30f8736195f2781e5baa926ed5ad9667b547e00abb7c4/yaml4rst-0.1.0.dev0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "4ee06173ef74a45a31ccedd58065e5b4", "sha256": "5cdaf287646ea4d4614851993272789bfd79ab72bc9e4e679c3a680cef6ce12b" }, "downloads": -1, "filename": "yaml4rst-0.1.1-py3-none-any.whl", "has_sig": true, "md5_digest": "4ee06173ef74a45a31ccedd58065e5b4", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 27361, "upload_time": "2016-11-05T18:21:35", "url": "https://files.pythonhosted.org/packages/8b/e7/c9eab1085cea413e63ca216ca61902d430f6eaa6180b9bdf265232848618/yaml4rst-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5078aba5cc598d07b56f92f19fdede5f", "sha256": "357362ac0cc40b9b2c30d2ffaf63c80378f3dd70cfc948ba85a6873a32c7de73" }, "downloads": -1, "filename": "yaml4rst-0.1.1.tar.gz", "has_sig": true, "md5_digest": "5078aba5cc598d07b56f92f19fdede5f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 105782, "upload_time": "2016-11-05T18:21:37", "url": "https://files.pythonhosted.org/packages/c3/a4/6c24019a2f0c90392edd3293f9164baf5228f0bccb6b312ceca8b5ae4e39/yaml4rst-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "6ae0dccec2648868a237e03c35e1409f", "sha256": "41717f9a9b203f65eedfafc5e5628a5e5d63ab70d7580e578b181c4a2cb84d26" }, "downloads": -1, "filename": "yaml4rst-0.1.2-py3-none-any.whl", "has_sig": true, "md5_digest": "6ae0dccec2648868a237e03c35e1409f", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 18413, "upload_time": "2016-11-18T21:19:22", "url": "https://files.pythonhosted.org/packages/0f/df/349b1e6fe9fe99b13afb2803957c77240dc58b8f0c692245f12ef4519065/yaml4rst-0.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "afa9133a18f38dbc110c55e8aa0f684b", "sha256": "1eb869913201111616d748344bea6157f1beff0ad3e381684fdd491ec6226d1f" }, "downloads": -1, "filename": "yaml4rst-0.1.2.tar.gz", "has_sig": true, "md5_digest": "afa9133a18f38dbc110c55e8aa0f684b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 106479, "upload_time": "2016-11-18T21:19:25", "url": "https://files.pythonhosted.org/packages/25/fa/8ef2294ea76788667318db5a8fec44fa1f221f1fd369874bf94a9c3ce7f8/yaml4rst-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "4ec7df12b8fd36b1ce442f47704d10bd", "sha256": "0976c3e973b8a9d6061285b70140be3e38405a56f8fbc413f9e2c90231d19721" }, "downloads": -1, "filename": "yaml4rst-0.1.3-py3-none-any.whl", "has_sig": true, "md5_digest": "4ec7df12b8fd36b1ce442f47704d10bd", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 18455, "upload_time": "2017-02-13T23:25:53", "url": "https://files.pythonhosted.org/packages/36/1e/af3e929062a12b39d9005cf02d21394b71032f01913259ce174abd4eb323/yaml4rst-0.1.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1a53ba1cc758bc07fd072270f645de3b", "sha256": "5ddaa28f26d93ea0a9f73f0f0c6e399759f2df110b6a5056c14e34ea6b24bb3f" }, "downloads": -1, "filename": "yaml4rst-0.1.3.tar.gz", "has_sig": true, "md5_digest": "1a53ba1cc758bc07fd072270f645de3b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 125499, "upload_time": "2017-02-13T23:25:56", "url": "https://files.pythonhosted.org/packages/dc/9a/edeee4b88cb5761b899e6701b86c10921362e79ea123ad8600bd0348ce26/yaml4rst-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "b0c1ba4734266e67cba8356ed5c16d2f", "sha256": "d092b01dcbc480a91ad4f570ba6be6f0fcb1588ae4c12e9b7643ac934977eb8e" }, "downloads": -1, "filename": "yaml4rst-0.1.4-py3-none-any.whl", "has_sig": true, "md5_digest": "b0c1ba4734266e67cba8356ed5c16d2f", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 18455, "upload_time": "2017-02-21T19:01:38", "url": "https://files.pythonhosted.org/packages/31/8f/b2015be895b3760219b4ed898509a666ab3c7e4b96280374b8de9a76dd2b/yaml4rst-0.1.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "64378f361f1854494de25fa8d116d41b", "sha256": "0190c997e4dca10d3e014c30152f55c126d23b9be7bda1fcf13b6cabb249ed0a" }, "downloads": -1, "filename": "yaml4rst-0.1.4.tar.gz", "has_sig": true, "md5_digest": "64378f361f1854494de25fa8d116d41b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 125740, "upload_time": "2017-02-21T19:01:41", "url": "https://files.pythonhosted.org/packages/98/9c/2b16e46c9c75dfa33b6238e0dc69a08df2c84d13d5f947b2bcb13873f9f2/yaml4rst-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "9800966586910fd0418598712921dcb0", "sha256": "8ee0b9606cdf8a1d6fda1d20b1d68004652d889863720680ec1c0166a416c3f8" }, "downloads": -1, "filename": "yaml4rst-0.1.5-py3-none-any.whl", "has_sig": true, "md5_digest": "9800966586910fd0418598712921dcb0", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 18849, "upload_time": "2017-03-16T19:27:09", "url": "https://files.pythonhosted.org/packages/b9/e1/a06d78b9bbfe6044fd307aa638583eee53cdf09de805eb142acc41e9a929/yaml4rst-0.1.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a3463573dfe475103ac9a40994fc8f17", "sha256": "1a2f154c3790126c9934691383d62350b3aba45acb740a3082bbc08e6495b5ea" }, "downloads": -1, "filename": "yaml4rst-0.1.5.tar.gz", "has_sig": true, "md5_digest": "a3463573dfe475103ac9a40994fc8f17", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 132049, "upload_time": "2017-03-16T19:27:11", "url": "https://files.pythonhosted.org/packages/da/ee/86edb4beede226b774072b004a0e49ccb50ee824c3c2da8d3411a01adbdb/yaml4rst-0.1.5.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "a22008180dde9ac821b4a9d6278f7487", "sha256": "5b7759101e87f3e51f16ea4ca721a3517b13dff890bb6e930252b69b745b6ea5" }, "downloads": -1, "filename": "yaml4rst-0.1.6-py3-none-any.whl", "has_sig": true, "md5_digest": "a22008180dde9ac821b4a9d6278f7487", "packagetype": "bdist_wheel", "python_version": "any", "requires_python": null, "size": 18976, "upload_time": "2017-04-29T09:26:09", "url": "https://files.pythonhosted.org/packages/f5/6a/5774cf9f1c33d8fa17aa6605487044045c4078587abe690a8d7eadc2d39f/yaml4rst-0.1.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "87149e48630962690fab119358bfe944", "sha256": "98cbcf2089ea2e1941de5d3226641f2c17b1201f1f811fcbfe97d03323824215" }, "downloads": -1, "filename": "yaml4rst-0.1.6.tar.gz", "has_sig": true, "md5_digest": "87149e48630962690fab119358bfe944", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 135373, "upload_time": "2017-04-29T09:26:24", "url": "https://files.pythonhosted.org/packages/ed/ed/8dc0452d26096ddf80f96383acb8fd18a523df96735660be8c9e91aeb693/yaml4rst-0.1.6.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a22008180dde9ac821b4a9d6278f7487", "sha256": "5b7759101e87f3e51f16ea4ca721a3517b13dff890bb6e930252b69b745b6ea5" }, "downloads": -1, "filename": "yaml4rst-0.1.6-py3-none-any.whl", "has_sig": true, "md5_digest": "a22008180dde9ac821b4a9d6278f7487", "packagetype": "bdist_wheel", "python_version": "any", "requires_python": null, "size": 18976, "upload_time": "2017-04-29T09:26:09", "url": "https://files.pythonhosted.org/packages/f5/6a/5774cf9f1c33d8fa17aa6605487044045c4078587abe690a8d7eadc2d39f/yaml4rst-0.1.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "87149e48630962690fab119358bfe944", "sha256": "98cbcf2089ea2e1941de5d3226641f2c17b1201f1f811fcbfe97d03323824215" }, "downloads": -1, "filename": "yaml4rst-0.1.6.tar.gz", "has_sig": true, "md5_digest": "87149e48630962690fab119358bfe944", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 135373, "upload_time": "2017-04-29T09:26:24", "url": "https://files.pythonhosted.org/packages/ed/ed/8dc0452d26096ddf80f96383acb8fd18a523df96735660be8c9e91aeb693/yaml4rst-0.1.6.tar.gz" } ] }