{
    "info": {
        "author": "Antoine Augusti",
        "author_email": "hi@antoine-augusti.fr",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3"
        ],
        "description": "[![Software License](https://img.shields.io/badge/License-MIT-orange.svg?style=flat-square)](https://github.com/entrepreneur-interet-general/open_api_schemas_to_markdown/blob/master/LICENSE.md)\n![CircleCI](https://img.shields.io/circleci/project/github/entrepreneur-interet-general/open_api_schemas_to_markdown.svg?style=flat-square)\n![PyPI](https://img.shields.io/pypi/open_api_schemas_to_markdown.svg?style=flat-square)\n\n\n# OpenAPI Components Schemas to Markdown\nThe goal of this package is to generate [Github Flavored Markdown](https://github.github.com/gfm/) documentation of Components Schemas from the [OpenAPI 3 specification](https://github.com/OAI/OpenAPI-Specification).\n\nSay you've got a YAML file:\n```yml\nopenapi: \"3.0.0\"\ninfo:\n  version: \"0\"\n  title: Demo\npaths:\n  /demo:\n    get:\n      summary: Demo\n      responses:\n        '200':\n          description: OK\ncomponents:\n  schemas:\n    ResultatHumain:\n      properties:\n        operation_id:\n          type: integer\n          format: int64\n          description: Le num\u00e9ro unique de l'op\u00e9ration\n          example: 1119920371\n        categorie_personne:\n          type: string\n          description: Indique la cat\u00e9gorie de personne impliqu\u00e9e dans le bilan humain\n          example: P\u00eacheur fran\u00e7ais\n        resultat_humain:\n          type: string\n          description: Description du bilan humain\n          example: Personne secourue\n        nombre:\n          type: number\n          format: int32\n          minimum: 0\n          description: Nombre de personnes impliqu\u00e9es dans ce bilan\n          example: 3\n        dont_nombre_blesse:\n          type: number\n          format: int32\n          minimum: 0\n          description: Indique le nombre de personnes bless\u00e9es dans le bilan\n          example: 1\n\n```\n\nThe package will produce a Markdown file from the YAML specification file with the following content:\n```markdown\n## ResultatHumain\n|Field|Type|Description|Example|Properties|\n|---|---|---|---|---|\n|operation_id|integer($int64)|Le num\u00e9ro unique de l'op\u00e9ration|1119920371||\n|categorie_personne|string|Indique la cat\u00e9gorie de personne impliqu\u00e9e dans le bilan humain|P\u00eacheur fran\u00e7ais||\n|resultat_humain|string|Description du bilan humain|Personne secourue||\n|nombre|number($int32)|Nombre de personnes impliqu\u00e9es dans ce bilan|3|minimum: 0|\n|dont_nombre_blesse|number($int32)|Indique le nombre de personnes bless\u00e9es dans le bilan|1|minimum: 0|\n```\n\nAnd if you render it:\n## ResultatHumain\n|Field|Type|Description|Example|Properties|\n|---|---|---|---|---|\n|operation_id|integer($int64)|Le num\u00e9ro unique de l'op\u00e9ration|1119920371||\n|categorie_personne|string|Indique la cat\u00e9gorie de personne impliqu\u00e9e dans le bilan humain|P\u00eacheur fran\u00e7ais||\n|resultat_humain|string|Description du bilan humain|Personne secourue||\n|nombre|number($int32)|Nombre de personnes impliqu\u00e9es dans ce bilan|3|minimum: 0|\n|dont_nombre_blesse|number($int32)|Indique le nombre de personnes bless\u00e9es dans le bilan|1|minimum: 0|\n\n## Installation\n```\npip install open-api-schemas-to-markdown\n```\n\n## Usage\nThe package provides a command line tool.\n```\n$ oa-to-md -h\nusage: oa-to-md [-h] input_filepath output_filepath [locale]\n\npositional arguments:\n  input_filepath   The OpenAPI 3 YAML filepath\n  output_filepath  The desired output filepath of the Markdown file\n  locale           Locale to use when generating the Markdown file. Available:\n                   en, fr\n\noptional arguments:\n  -h, --help       show this help message and exit\n```\n\nExample:\n```\noa-to-md open_api.yml documentation.md\n```\n\n## Notice\nThis software is available under the MIT license and was developed as part of the [Entrepreneur d'Int\u00e9r\u00eat G\u00e9n\u00e9ral program](https://entrepreneur-interet-general.etalab.gouv.fr) by the French government.\n\nProjet d\u00e9velopp\u00e9 dans le cadre du programme \u00ab [Entrepreneur d\u2019int\u00e9r\u00eat g\u00e9n\u00e9ral](https://entrepreneur-interet-general.etalab.gouv.fr) \u00bb.\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/entrepreneur-interet-general/open_api_schemas_to_markdown",
        "keywords": "openapi,documentation,markdown,gfm",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "open-api-schemas-to-markdown",
        "package_url": "https://pypi.org/project/open-api-schemas-to-markdown/",
        "platform": "",
        "project_url": "https://pypi.org/project/open-api-schemas-to-markdown/",
        "project_urls": {
            "Homepage": "https://github.com/entrepreneur-interet-general/open_api_schemas_to_markdown"
        },
        "release_url": "https://pypi.org/project/open-api-schemas-to-markdown/0.3/",
        "requires_dist": [
            "PyYAML",
            "future",
            "yamlordereddictloader",
            "nose; extra == 'dev'"
        ],
        "requires_python": ">=2.7, <4",
        "summary": "Generate Markdown documentation from OpenAPI 3 Components Schemas",
        "version": "0.3"
    },
    "last_serial": 4336239,
    "releases": {
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a1e57fcb0011185d57f0dc2d89c5d2bf",
                    "sha256": "5d6c23b1e7b13da8a51b1ed1fa8ae0cd2fa045c0d9189525638cfbcb51ffb1a2"
                },
                "downloads": -1,
                "filename": "open_api_schemas_to_markdown-0.1.1-py2-none-any.whl",
                "has_sig": false,
                "md5_digest": "a1e57fcb0011185d57f0dc2d89c5d2bf",
                "packagetype": "bdist_wheel",
                "python_version": "py2",
                "requires_python": ">=2.7, <4",
                "size": 4539,
                "upload_time": "2018-04-19T14:46:14",
                "url": "https://files.pythonhosted.org/packages/8c/49/41127646a5dbf227033343e7f787dea692df07abe2fa2f1179b4160f0f2f/open_api_schemas_to_markdown-0.1.1-py2-none-any.whl"
            }
        ],
        "0.1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "15ed1788570d61c75ccbe26307ae85b2",
                    "sha256": "cc104332d51fbb752df4fd0a0b8f97a99bf266d6ee83b6356186c9d308b7a0ea"
                },
                "downloads": -1,
                "filename": "open_api_schemas_to_markdown-0.1.2-py2-none-any.whl",
                "has_sig": false,
                "md5_digest": "15ed1788570d61c75ccbe26307ae85b2",
                "packagetype": "bdist_wheel",
                "python_version": "py2",
                "requires_python": ">=2.7, <4",
                "size": 4560,
                "upload_time": "2018-04-19T14:47:55",
                "url": "https://files.pythonhosted.org/packages/c3/f9/90a65a2b611b95d740a0458cde5324d602da6441dae79fb9f3667d56362b/open_api_schemas_to_markdown-0.1.2-py2-none-any.whl"
            }
        ],
        "0.1.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "4bf5a85275ac1006b1d45002a25ab5f9",
                    "sha256": "7ac534d7fb596d33b59bbc10aa6d90b80cd858c8213ed71b3a641b16e5012f7d"
                },
                "downloads": -1,
                "filename": "open_api_schemas_to_markdown-0.1.3-py2-none-any.whl",
                "has_sig": false,
                "md5_digest": "4bf5a85275ac1006b1d45002a25ab5f9",
                "packagetype": "bdist_wheel",
                "python_version": "py2",
                "requires_python": ">=2.7, <4",
                "size": 4559,
                "upload_time": "2018-04-20T07:58:14",
                "url": "https://files.pythonhosted.org/packages/6e/cc/152e998fa8e71ccf23e2da1e75f2e8d3deda95ffb5cb59eb125a1fab2a8d/open_api_schemas_to_markdown-0.1.3-py2-none-any.whl"
            }
        ],
        "0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ed19a06141856c94d5312b517799b5a1",
                    "sha256": "ae5bbba8070c225fc9c1f0ecf0bd02266d9f1d3501a630ce2ec8612b95b75941"
                },
                "downloads": -1,
                "filename": "open_api_schemas_to_markdown-0.2-py2-none-any.whl",
                "has_sig": false,
                "md5_digest": "ed19a06141856c94d5312b517799b5a1",
                "packagetype": "bdist_wheel",
                "python_version": "py2",
                "requires_python": ">=2.7, <4",
                "size": 5431,
                "upload_time": "2018-06-05T14:34:43",
                "url": "https://files.pythonhosted.org/packages/a6/04/f1ec0e76ddf5e07b88fb35789293dd09716fc310e784b1d4e81f3416bcfb/open_api_schemas_to_markdown-0.2-py2-none-any.whl"
            }
        ],
        "0.2.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2b4b2248433c9b4ca1e997ea9cef5528",
                    "sha256": "55b8057a9e4575a96f5b6193a2880c88305982c6c784716966c2d75c8ce21a58"
                },
                "downloads": -1,
                "filename": "open_api_schemas_to_markdown-0.2.1-py2-none-any.whl",
                "has_sig": false,
                "md5_digest": "2b4b2248433c9b4ca1e997ea9cef5528",
                "packagetype": "bdist_wheel",
                "python_version": "py2",
                "requires_python": ">=2.7, <4",
                "size": 5452,
                "upload_time": "2018-06-05T14:47:49",
                "url": "https://files.pythonhosted.org/packages/60/cc/b91b821829118c78617501a48e5faa8f631ff99a0a8f07c69c6c61cb65f8/open_api_schemas_to_markdown-0.2.1-py2-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "88c972e9ef5da6363015854b1e5ba552",
                    "sha256": "52cf59209d48d74af15e49d2fc32e78756b486c4ebd8508bb4054560d2320374"
                },
                "downloads": -1,
                "filename": "open_api_schemas_to_markdown-0.2.1-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "88c972e9ef5da6363015854b1e5ba552",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">=2.7, <4",
                "size": 5465,
                "upload_time": "2018-07-04T17:47:33",
                "url": "https://files.pythonhosted.org/packages/07/9e/0815ad68fb0d430375f2b7d31197ee281e73a7e80a9afaa073c449b8ac8b/open_api_schemas_to_markdown-0.2.1-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "56bcb2e77c9c823b6df10b91d0602e2f",
                    "sha256": "50a8f3c92607474ee64aa8dc925d4ef394eaa3d2a6aac56bf796e9bf23cb1851"
                },
                "downloads": -1,
                "filename": "open_api_schemas_to_markdown-0.2.1.tar.gz",
                "has_sig": false,
                "md5_digest": "56bcb2e77c9c823b6df10b91d0602e2f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=2.7, <4",
                "size": 4394,
                "upload_time": "2018-07-04T17:47:34",
                "url": "https://files.pythonhosted.org/packages/f6/77/ea0e9cc3ed7ce22b1d45c9e329b33247d3e90260fbae08e5c3aa5dc57c77/open_api_schemas_to_markdown-0.2.1.tar.gz"
            }
        ],
        "0.2.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "49716df4d5296975bfd017c00c79b6fd",
                    "sha256": "3facc203260a51d52e11211af853789cb601247a0f5ad03f3da4858f358d5f94"
                },
                "downloads": -1,
                "filename": "open_api_schemas_to_markdown-0.2.2-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "49716df4d5296975bfd017c00c79b6fd",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">=2.7, <4",
                "size": 5465,
                "upload_time": "2018-07-04T17:47:08",
                "url": "https://files.pythonhosted.org/packages/64/00/d82375c8921243e402d0fcd07cda9cf2d6215a56f5e6cd46a8dd9b61185f/open_api_schemas_to_markdown-0.2.2-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "1706790e7d172ef85145074ab522bc7d",
                    "sha256": "986c73de64ed38d6f970eabd91bfd217e1d753d9a3d6f15659297d08bcdc9754"
                },
                "downloads": -1,
                "filename": "open_api_schemas_to_markdown-0.2.2.tar.gz",
                "has_sig": false,
                "md5_digest": "1706790e7d172ef85145074ab522bc7d",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=2.7, <4",
                "size": 4397,
                "upload_time": "2018-07-04T17:47:09",
                "url": "https://files.pythonhosted.org/packages/7b/2f/f42173a0eba063ec5cf571fbc874678324d6d59719cb71e4527c1da615eb/open_api_schemas_to_markdown-0.2.2.tar.gz"
            }
        ],
        "0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "b859125fa1f9c45f804ff76b5f478266",
                    "sha256": "5a46c48bb721e717196ad115655b8c5cf518d12ee6fd1273d5af1006f8cf5580"
                },
                "downloads": -1,
                "filename": "open_api_schemas_to_markdown-0.3-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "b859125fa1f9c45f804ff76b5f478266",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">=2.7, <4",
                "size": 5432,
                "upload_time": "2018-10-03T11:27:47",
                "url": "https://files.pythonhosted.org/packages/f8/ce/8c02bfa64e622ff1c7cb0d7889e1aeb77e7abba4bbc5aa1a706e5d01a2e2/open_api_schemas_to_markdown-0.3-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "060c8aba46b4fab22405884057b179f9",
                    "sha256": "b62186db8b14a75c0489440d3f6ad16320a892277491433bcd8d202139c867fc"
                },
                "downloads": -1,
                "filename": "open_api_schemas_to_markdown-0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "060c8aba46b4fab22405884057b179f9",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=2.7, <4",
                "size": 4398,
                "upload_time": "2018-10-03T11:27:48",
                "url": "https://files.pythonhosted.org/packages/69/e0/61425177950d50829d5666f94b11ff9b311db75ffe8cc56243fae42e7514/open_api_schemas_to_markdown-0.3.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "b859125fa1f9c45f804ff76b5f478266",
                "sha256": "5a46c48bb721e717196ad115655b8c5cf518d12ee6fd1273d5af1006f8cf5580"
            },
            "downloads": -1,
            "filename": "open_api_schemas_to_markdown-0.3-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b859125fa1f9c45f804ff76b5f478266",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=2.7, <4",
            "size": 5432,
            "upload_time": "2018-10-03T11:27:47",
            "url": "https://files.pythonhosted.org/packages/f8/ce/8c02bfa64e622ff1c7cb0d7889e1aeb77e7abba4bbc5aa1a706e5d01a2e2/open_api_schemas_to_markdown-0.3-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "060c8aba46b4fab22405884057b179f9",
                "sha256": "b62186db8b14a75c0489440d3f6ad16320a892277491433bcd8d202139c867fc"
            },
            "downloads": -1,
            "filename": "open_api_schemas_to_markdown-0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "060c8aba46b4fab22405884057b179f9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=2.7, <4",
            "size": 4398,
            "upload_time": "2018-10-03T11:27:48",
            "url": "https://files.pythonhosted.org/packages/69/e0/61425177950d50829d5666f94b11ff9b311db75ffe8cc56243fae42e7514/open_api_schemas_to_markdown-0.3.tar.gz"
        }
    ]
}