Code Monkey home page Code Monkey logo

protobuf-tools's Introduction

Protobuf Tools

A docker image with protobuf and a handful set of plugins.

Motivation

The whole idea is to provide an easy-almost-no-setup way to generate resources and documentation from protos.

Dependencies

  • Docker

Content

This image gives you a compiled protobuf and some of its plugins (not so many for now):

Usage

docker run with a couple options:

# Here we're inside your proto's folder, let's call it `my-protos`
cd ~/my-protos

docker run \
  --name my-protos
  -v `pwd`:/my-protos:ro \
  -w /my-protos \
  --rm -it brennovich/protobuf-tools:latest protoc --doc_out=html,index.html:/build *.proto

# Make sure to use docker cp instead of writing in mounted folder, it avoid permissions issues and is much more flexible
docker cp my-protos:/build compiled-protos
docker rm my-protos

For more examples compiling for various languages look `[Makefile]

Test, buid & release

All of that can be done using makefile:

make test # this will build a docker image of current HEAD and run plugins and extensions
make release RELEASE=3.0.0 # build a docker iamge, tag and publish it to brennovich/protobuf-tools docker hub repo

Checkout [Makefile] for more tasks ;)

Contributing

  1. Fork it
  2. Fix, or add your feature in a new branch
  3. Open up a Pull Request against this repo with an useful description
  4. Try to stick with formating conventions already used in the files

protobuf-tools's People

Contributors

brennovich avatar cairesvs avatar jasiek avatar marcelbuesing avatar nykolaslima avatar resilva87 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.