{ "info": { "author": "Graham Thomas", "author_email": "grahamthethomas@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "\n\n# Apidoc to Openapi Converter   [![guide](https://img.shields.io/pypi/v/apidoc-to-openapi)](https://github.com/grahammthomas/apidoc_to_openapi)\n\n[Apidoc](http://apidocjs.com/) syntax is very easy and lightweight, whereas [Openapi aka Swagger](https://swagger.io/docs/specification/about/) syntax is very verbose and not noob friendly. The goal of this project is to make documenting api endpoints so easy that developers won't mind spending the time to do it, instead of just ignoring documentation.\n\n## Apidoc conversion coverage\n\nConvertable Annotations:\n\n```\n@api\n@apiName\n@apiGroup\n@apiParam\n@apiSuccess\n```\n\nFeel free to PR in any other annotations you need.\n\n### Installing\n\n```\nComing soon\n```\n\n```\nusage: apidoc_to_openapi [-h] -i path [-o path] [--yaml]\n\noptional arguments:\n -h, --help show this help message and exit\n -o path File output (default: stdout)\n --yaml Convert output to yaml format\n\nRequired:\n -i path File or directory containing apidoc annotations\n```\n\n## Running the tests\n\nUsed pytest for testing. Test coverage isn't near where I want it to be.\n\n## Coding Style\n\nUsing black formatter and pylint\n\n## Authors\n\n- **Graham Thomas** - _Initial work_\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details\n\n## Acknowledgments\n\n- I have no friends\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/GrahamMThomas/apidoc_to_openapi", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "apidoc-to-openapi", "package_url": "https://pypi.org/project/apidoc-to-openapi/", "platform": "", "project_url": "https://pypi.org/project/apidoc-to-openapi/", "project_urls": { "Homepage": "https://github.com/GrahamMThomas/apidoc_to_openapi" }, "release_url": "https://pypi.org/project/apidoc-to-openapi/0.0.1/", "requires_dist": [ "colorama", "pyyaml" ], "requires_python": ">=3.6", "summary": "A python package which converts apidoc comments in various languages to OpenApi Spec .json files.", "version": "0.0.1" }, "last_serial": 5827938, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "72af9eb41cade332fed14a84414df315", "sha256": "a4912da303e218e4558986ab8ee106d80fae48c393178ffa0c9124d288960475" }, "downloads": -1, "filename": "apidoc_to_openapi-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "72af9eb41cade332fed14a84414df315", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 15081, "upload_time": "2019-09-13T22:11:13", "url": "https://files.pythonhosted.org/packages/ed/ad/b26421acf989809becf9afb5525b6179da20229d443da83cfb9a308e73ea/apidoc_to_openapi-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "273325abdc2dbd3a737e698cad3ecbda", "sha256": "9bf7442f4400643ce89cba9cb5a6c3ee76def2c988b1f8e23254141c6b254b48" }, "downloads": -1, "filename": "apidoc_to_openapi-0.0.1.tar.gz", "has_sig": false, "md5_digest": "273325abdc2dbd3a737e698cad3ecbda", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 8405, "upload_time": "2019-09-13T22:11:15", "url": "https://files.pythonhosted.org/packages/43/ef/92e5bb4b2e0d9d13b5e998b81653a32c9b63406d26ca7c0c13690e3c62b4/apidoc_to_openapi-0.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "72af9eb41cade332fed14a84414df315", "sha256": "a4912da303e218e4558986ab8ee106d80fae48c393178ffa0c9124d288960475" }, "downloads": -1, "filename": "apidoc_to_openapi-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "72af9eb41cade332fed14a84414df315", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 15081, "upload_time": "2019-09-13T22:11:13", "url": "https://files.pythonhosted.org/packages/ed/ad/b26421acf989809becf9afb5525b6179da20229d443da83cfb9a308e73ea/apidoc_to_openapi-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "273325abdc2dbd3a737e698cad3ecbda", "sha256": "9bf7442f4400643ce89cba9cb5a6c3ee76def2c988b1f8e23254141c6b254b48" }, "downloads": -1, "filename": "apidoc_to_openapi-0.0.1.tar.gz", "has_sig": false, "md5_digest": "273325abdc2dbd3a737e698cad3ecbda", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 8405, "upload_time": "2019-09-13T22:11:15", "url": "https://files.pythonhosted.org/packages/43/ef/92e5bb4b2e0d9d13b5e998b81653a32c9b63406d26ca7c0c13690e3c62b4/apidoc_to_openapi-0.0.1.tar.gz" } ] }