protoc-gen-swagger
====================
.. image:: https://travis-ci.org/universe-proton/protoc-gen-swagger.svg?branch=master
:target: https://travis-ci.org/universe-proton/protoc-gen-swagger
A python package for swagger's annotation protobuf files, which are located inside `grpc-gateway <https://github.com/grpc-ecosystem/grpc-gateway>`_ repository.
`Swagger <https://swagger.io/>`_ is a popular api tool. When you import swagger proto files in your protobuf message file, you may get stuck when using the generated python code.
An import error as the following:
.. code-block::
ModuleNotFoundError: No module named 'protoc_gen_swagger'
With this package, you could forget the error.
Installation
============
We can simply use pip to install, as the following:
.. code-block:: bash
$ pip install protoc-gen-swagger
or installing from git
.. code-block:: bash
$ pip install git+https://github.com/universe-proton/protoc-gen-swagger
Maintain
=========
When the source repository `grpc-gateway <https://github.com/grpc-ecosystem/grpc-gateway>`_ is taged, we can use command `bash gen.sh <tag-version>` to update the package.
Maybe we could do some automated work in the future.
Now, this package version 0.1.0 is the same as grpc-gateway version v1.3.1 .
How to Contribute
=================
Open an `issue <https://github.com/universe-proton/protoc-gen-swagger/issues>`_, join a discussion or make a pull request.
Raw data
{
"_id": null,
"home_page": "https://github.com/universe-proton/protoc-gen-swagger",
"name": "protoc-gen-swagger",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "proto swagger protobuf gRPC",
"author": "universe-proton",
"author_email": "",
"download_url": "",
"platform": "",
"description": "\nprotoc-gen-swagger\n====================\n\n.. image:: https://travis-ci.org/universe-proton/protoc-gen-swagger.svg?branch=master\n :target: https://travis-ci.org/universe-proton/protoc-gen-swagger\n\n\nA python package for swagger's annotation protobuf files, which are located inside `grpc-gateway <https://github.com/grpc-ecosystem/grpc-gateway>`_ repository.\n\n`Swagger <https://swagger.io/>`_ is a popular api tool. When you import swagger proto files in your protobuf message file, you may get stuck when using the generated python code.\nAn import error as the following:\n\n.. code-block::\n\n ModuleNotFoundError: No module named 'protoc_gen_swagger'\n\nWith this package, you could forget the error.\n\n\nInstallation\n============\n\nWe can simply use pip to install, as the following:\n\n.. code-block:: bash\n\n $ pip install protoc-gen-swagger\n\nor installing from git\n\n.. code-block:: bash\n\n $ pip install git+https://github.com/universe-proton/protoc-gen-swagger\n\n\nMaintain\n=========\n\nWhen the source repository `grpc-gateway <https://github.com/grpc-ecosystem/grpc-gateway>`_ is taged, we can use command `bash gen.sh <tag-version>` to update the package.\nMaybe we could do some automated work in the future.\n\nNow, this package version 0.1.0 is the same as grpc-gateway version v1.3.1 .\n\n\nHow to Contribute\n=================\n\nOpen an `issue <https://github.com/universe-proton/protoc-gen-swagger/issues>`_, join a discussion or make a pull request.\n\n\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "A python package for swagger annotation proto files.",
"version": "0.1.0",
"split_keywords": [
"proto",
"swagger",
"protobuf",
"grpc"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "c7378563cf447b8052670df920a7aba1",
"sha256": "cdc043da538865f055a7f22b304a35085cef269dc33e2f3408b12d397e8d8b4b"
},
"downloads": -1,
"filename": "protoc_gen_swagger-0.1.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "c7378563cf447b8052670df920a7aba1",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 9443,
"upload_time": "2018-01-29T14:10:53",
"upload_time_iso_8601": "2018-01-29T14:10:53.570378Z",
"url": "https://files.pythonhosted.org/packages/7d/7f/d8f8d81a921f07e703cabf8a0b5bb6cbc26e3bce7614db905c3c7637315a/protoc_gen_swagger-0.1.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2018-01-29 14:10:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "universe-proton",
"github_project": "protoc-gen-swagger",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "protoc-gen-swagger"
}
JSON
