Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Markdown protocol buffer code generator

Project description

md-protobuf provides a generator for generating mardown documnetation files from google protocol buffer files.

Producing Code

md-protobuf provides a plugin for the protoc protocol buffer compiler (it ships with protocol buffers). This plugin tells protoc to produce a set of mardown output files, which contains documentation derived from the comments in the proto file.

First, obtain a copy of md-protobuf:

$ git clone git@github.com:mickem/md-protobuf.git
$ cd md-protobuf

Next, install md-protobuf:

$ python setup.py install

Finally, launch protoc and tell it to produce Md output:

$ protoc -I/path/to/your/proto/files --md_out=/output/path file1.proto file2.proto

You simply need to add --md_out to the arguments to protoc to get it to produce the Markdown output files.

Under the hood, protoc is looking for the program protoc-gen-md somewhere in your $PATH. You can modify $PATH in lieux of installing the package, if you desire.

Project details


Release history Release notifications

This version

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for md-protobuf, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size md_protobuf-1.0.0-py3-none-any.whl (10.4 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size md-protobuf-1.0.0.tar.gz (4.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page