Plugin for setuptools
that adds support for compiling protobuf files.
The plugin requires the external protoc
executable that is part of the
protobuf project to be present.
On Debian systems, this executable is shipped in the protobuf-compiler
package.
If the protoc_version
option is specified, the specified version of protoc
will be downloaded from github. When it is not specified, a protoc
binary is
expected to be present in the environment. You can override the binary with the
PROTOC environment variable.
Optionally, it can also generate typing hints if the mypy
extra is selected.
There is no separate install_proto
command; generated files (e.g. _pb2.py
files) are placed in the source tree and expected to be installed by other
install commands.
You can configure setuptools-protobuf
in either setup.py
, setup.cfg
or pyproject.toml
.
from setuptools_protobuf import Protobuf
setup(
...
setup_requires=['setuptools-protobuf'],
protobufs=[Protobuf('example/foo.proto')],
)
...
[options]
setup_requires =
setuptools
setuptools-protobuf
[build-system]
requires = ["setuptools", "setuptools-protobuf"]
[tool.setuptools-protobuf]
protobufs = ["example/foo.proto"]
# Require the generation of typing hints:
mypy = true
# Optionally, set the specific protoc version to use:
protoc_version = '25.1'
To install protoc in a GitHub action, you can use the setup-protoc action:
- name: Install Protoc
uses: arduino/setup-protoc@v2