add note about protoc version and add Make command to generate protobuf files

This commit is contained in:
Alex Stokes 2019-08-02 12:20:48 -07:00
parent e55d9f2e60
commit 2dfd7794b6
No known key found for this signature in database
GPG Key ID: 51CE1721B245C086
2 changed files with 8 additions and 0 deletions

View File

@ -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

View File

@ -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.