{ "info": { "author": "Konstantin Molchanov", "author_email": "moigagoo@live.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Environment :: Web Environment", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Documentation", "Topic :: Utilities" ], "description": "###############\napidoc2markdown\n###############\n\nApidoc_ is an open specification for documenting REST APIs in JSON or YAML.\nImperfect as it is, it's de facto a standard for many API developers.\n\nThis extension lets you render your swagger.json file as a Markdown document.\nYou can customize the output by providing your own Jinja2_ template.\n\n.. _Apidoc: http://apidocjs.com/\n.. _Jinja2: http://jinja.pocoo.org/\n\n\n.. warning::\n\n This extension was created for a particular project and thus is only\n guaranteed to work with this particular project! It is very much likely\n you'll have to modify apidoc.md.j2_ for your project.\n\n.. _apidoc.md.j2: https://github.com/moigagoo/apidoc2markdown/blob/master/apidoc.md.j2\n\n\n************\nInstallation\n************\n\n.. code-block:: shell\n\n $ pip install apidoc2markdown\n\n\n*****\nUsage\n*****\n\n.. code-block:: shell\n\n usage: apidoc2markdown-script.py [-h] [-i APIDOC_LOCATION] [-o OUTPUT]\n [-t TEMPLATE]\n\n optional arguments:\n -h, --help show this help message and exit\n -i APIDOC_LOCATION, --input APIDOC_LOCATION\n path to the directory with api_data.json\n and api_project.json (default: .)\n -o OUTPUT, --output OUTPUT\n path to the output Markdown file (default: swagger.md)\n -t TEMPLATE, --template TEMPLATE\n Jinja2 template used for conversion", "description_content_type": null, "docs_url": null, "download_url": "https://pypi.org/project/apidoc2markdown", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/moigagoo/apidoc2markdown", "keywords": null, "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "apidoc2markdown", "package_url": "https://pypi.org/project/apidoc2markdown/", "platform": "any", "project_url": "https://pypi.org/project/apidoc2markdown/", "project_urls": { "Download": "https://pypi.org/project/apidoc2markdown", "Homepage": "https://github.com/moigagoo/apidoc2markdown" }, "release_url": "https://pypi.org/project/apidoc2markdown/0.1.0/", "requires_dist": null, "requires_python": null, "summary": "Converter from Apidoc JSON to Markdown.", "version": "0.1.0" }, "last_serial": 2500314, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "99c36b947cc3d89bce71c33d8c3045cd", "sha256": "2751a623c53a3142915226ad9b01641a63a8cdd342c65e13c8ace89c31487889" }, "downloads": -1, "filename": "apidoc2markdown-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "99c36b947cc3d89bce71c33d8c3045cd", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 5503, "upload_time": "2016-12-05T13:45:48", "url": "https://files.pythonhosted.org/packages/d7/ab/7fcf4a51183d309f00bf63cf04de113f5198043dea14a977d2215f8620da/apidoc2markdown-0.1.0-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "99c36b947cc3d89bce71c33d8c3045cd", "sha256": "2751a623c53a3142915226ad9b01641a63a8cdd342c65e13c8ace89c31487889" }, "downloads": -1, "filename": "apidoc2markdown-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "99c36b947cc3d89bce71c33d8c3045cd", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 5503, "upload_time": "2016-12-05T13:45:48", "url": "https://files.pythonhosted.org/packages/d7/ab/7fcf4a51183d309f00bf63cf04de113f5198043dea14a977d2215f8620da/apidoc2markdown-0.1.0-py3-none-any.whl" } ] }