From 2dfd7794b6ac79c3be474d3f239d2e043381ab73 Mon Sep 17 00:00:00 2001 From: Alex Stokes Date: Fri, 2 Aug 2019 12:20:48 -0700 Subject: [PATCH] add note about protoc version and add Make command to generate protobuf files --- Makefile | 4 ++++ README.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/Makefile b/Makefile index 1eca2aae..49ec90b8 100644 --- a/Makefile +++ b/Makefile @@ -2,3 +2,7 @@ lintroll: # NOTE: disabling `mypy` until we get typing sorted in this repo # mypy -p libp2p -p examples --config-file {toxinidir}/mypy.ini black --check examples libp2p/__init__.py libp2p/host libp2p/kademlia libp2p/network libp2p/peer libp2p/protocol_muxer libp2p/pubsub/*.py libp2p/routing libp2p/security libp2p/stream_muxer libp2p/transport tests setup.py + +protobufs: + cd libp2p/pubsub/pb && protoc --python_out=. rpc.proto + cd libp2p/pubsub/pb && python -m grpc_tools.protoc -I. --python_out=. --grpc_python_out=. rpc.proto diff --git a/README.md b/README.md index 2e895d3e..92a44ac3 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,10 @@ pytest ``` Note that tests/libp2p/test_libp2p.py contains an end-to-end messaging test between two libp2p hosts, which is the bulk of our proof of concept. +## Requirements + +The protobuf description in this repository was generated by `protoc` at version `3.7.1`. + ## Feature Breakdown py-libp2p aims for conformity with [the standard libp2p modules](https://github.com/libp2p/libp2p/blob/master/REQUIREMENTS.md#libp2p-modules-implementations). Below is a breakdown of the modules we have developed, are developing, and may develop in the future.