py-libp2p/Makefile

FILES_TO_LINT = libp2p tests tests_interop examples setup.py
PB = libp2p/crypto/pb/crypto.proto libp2p/pubsub/pb/rpc.proto libp2p/security/insecure/pb/plaintext.proto libp2p/security/secio/pb/spipe.proto
PY = $(PB:.proto=_pb2.py)
PYI = $(PB:.proto=_pb2.pyi)

# Set default to `protobufs`, otherwise `format` is called when typing only `make`
all: protobufs

format:
	black $(FILES_TO_LINT)
	isort --recursive $(FILES_TO_LINT)
	docformatter -ir $(FILES_TO_LINT)

lintroll:
	mypy -p libp2p -p examples --config-file mypy.ini
	black --check $(FILES_TO_LINT)
	isort --recursive --check-only $(FILES_TO_LINT)
	flake8 $(FILES_TO_LINT)

protobufs: $(PY)

%_pb2.py: %.proto
	protoc --python_out=. --mypy_out=. $<

.PHONY: clean

clean:
	rm -f $(PY) $(PYI)
Move interop tests out of tests It is moved to the top level package `tests_interop`, to avoid circular dependency, with the dependency moved to `tox`. 2019-09-23 22:00:40 +08:00			`FILES_TO_LINT = libp2p tests tests_interop examples setup.py`
Add `secio` protobufs 2019-08-17 05:08:54 +08:00			`PB = libp2p/crypto/pb/crypto.proto libp2p/pubsub/pb/rpc.proto libp2p/security/insecure/pb/plaintext.proto libp2p/security/secio/pb/spipe.proto`
Add `plaintext.proto` Update Makefile to handle the import in `plaintext.proto`. Import path is modified to be relative to the project root. And we run `protoc` from where `Makefile` locates, i.e. the project root. Reference: - plaintext.proto: https://github.com/libp2p/go-libp2p-core/blob/62b2c6c482ef265f6b975d59244fd7b2169aaabf/sec/insecure/pb/plaintext.proto 2019-08-16 17:08:22 +08:00			`PY = $(PB:.proto=_pb2.py)`
			`PYI = $(PB:.proto=_pb2.pyi)`

			# Set default to `protobufs`, otherwise `format` is called when typing only `make`
			`all: protobufs`
Skip pb files in linters In isort, black, and flake8, respectively. Add `format` in Makefile Run top level packages only With `setup.py`, to avoid running other unrelated directories. Refactor 2019-08-03 18:02:27 +08:00
			`format:`
			`black $(FILES_TO_LINT)`
			`isort --recursive $(FILES_TO_LINT)`
Add automatic docstring formatter and apply 2019-10-24 14:41:10 +08:00			`docformatter -ir $(FILES_TO_LINT)`
Skip pb files in linters In isort, black, and flake8, respectively. Add `format` in Makefile Run top level packages only With `setup.py`, to avoid running other unrelated directories. Refactor 2019-08-03 18:02:27 +08:00
Disables `mypy` in CI Also moves linting to Makefile to take advantage of globbing. 2019-08-03 01:52:53 +08:00			`lintroll:`
Enable `mypy` in Makefile 2019-08-14 05:32:54 +08:00			`mypy -p libp2p -p examples --config-file mypy.ini`
Skip pb files in linters In isort, black, and flake8, respectively. Add `format` in Makefile Run top level packages only With `setup.py`, to avoid running other unrelated directories. Refactor 2019-08-03 18:02:27 +08:00			`black --check $(FILES_TO_LINT)`
			`isort --recursive --check-only $(FILES_TO_LINT)`
Move flake8 settings to tox.ini And add flake8 in the Makefile. 2019-08-04 00:11:49 +08:00			`flake8 $(FILES_TO_LINT)`
add note about protoc version and add Make command to generate protobuf files 2019-08-03 03:20:48 +08:00
Add `plaintext.proto` Update Makefile to handle the import in `plaintext.proto`. Import path is modified to be relative to the project root. And we run `protoc` from where `Makefile` locates, i.e. the project root. Reference: - plaintext.proto: https://github.com/libp2p/go-libp2p-core/blob/62b2c6c482ef265f6b975d59244fd7b2169aaabf/sec/insecure/pb/plaintext.proto 2019-08-16 17:08:22 +08:00			`protobufs: $(PY)`

			`%_pb2.py: %.proto`
			`protoc --python_out=. --mypy_out=. $<`

			`.PHONY: clean`

			`clean:`
			`rm -f $(PY) $(PYI)`