Skip to content

Commit

Permalink
readme: fix formatting and missing link
Browse files Browse the repository at this point in the history
  • Loading branch information
abn committed Jul 23, 2020
1 parent 6c92229 commit 6bd2ff7
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,18 @@

This project aims to be a base building block for [gNMI](https://github.com/openconfig/gnmi) projects written in Python.

The process of building pythonic libraries and applications using [gRPC](https://grpc.io/) and [Protocol Buffers] have been fragmented. This often means that a developer needs to copy over `proto` files, generate Python source from these using `protoc` and use them in-tree for their project. There already exists several projects built in this fashion. While functional, these can be hard to reuse or maintain, often times resulting stale code and no versioning.

`gnmi-proto` builds on top of the improvement already done by [betterproto](https://pypi.org/project/betterproto/) and in turn by the [grpclib](https://pypi.org/project/grpclib/) library. Here, we make available, as versioned packages, code generated from [gNMI protocol buffers](https://github.com/openconfig/gnmi/tree/master/proto).

The default implementation makes use of the [betterproto](https://pypi.org/project/betterproto/) `protoc` plugin to generate clean modern code. In addition, this also provides a `gnmi.proto.legacy` module exposing code generated by `protoc` using the the in-built Python generator.
The process of building pythonic libraries and applications using [gRPC](https://grpc.io/) and [Protocol Buffers](https://developers.google.com/protocol-buffers)
have been fragmented. This often means that a developer needs to copy over `proto` files, generate Python source from
these using `protoc` and use them in-tree for their project. There already exists several projects built in this fashion.
While functional, these can be hard to reuse or maintain, often times resulting stale code and no versioning.

`gnmi-proto` builds on top of the improvement already done by [betterproto](https://pypi.org/project/betterproto/) and
in turn by the [grpclib](https://pypi.org/project/grpclib/) library. Here, we make available, as versioned packages,
code generated from [gNMI protocol buffers](https://github.com/openconfig/gnmi/tree/master/proto).

The default implementation makes use of the [betterproto](https://pypi.org/project/betterproto/) `protoc` plugin to
generate clean modern code. In addition, this also provides a `gnmi.proto.legacy` module exposing code generated by
`protoc` using the the in-built Python generator.

## Example Usage
### Client
Expand Down

0 comments on commit 6bd2ff7

Please sign in to comment.