protobuf support for setuptools

Plugin for setuptools that adds support for compiling protobuf files.

Dependencies

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.

Usage

You can configure setuptools-protobuf in either setup.py, setup.cfg or pyproject.toml.

setup.py

from setuptools_protobuf import Protobuf

setup(
...
    setup_requires=['setuptools-protobuf'],
    protobufs=[Protobuf('example/foo.proto')],
)

setup.cfg

...

[options]
setup_requires =
    setuptools
    setuptools-protobuf

pyproject.toml

[build-system]
requires = ["setuptools", "setuptools-protobuf"]

[tool.setuptools-protobuf]
protobufs = ["example/foo.proto"]

# Wildcards are supported (evaluated relative to `proto_path`, or the
# project root if `proto_path` is unset):
# protobufs = ["example/*.proto", "protos/**/*.proto"]
#
# If `protobufs` is omitted entirely, all `.proto` files under the search
# root are discovered recursively.

# Require the generation of typing hints:
mypy = true

# Or disable typing hint generation entirely. When `mypy` is unset,
# setuptools-protobuf auto-enables stub generation if `protoc-gen-mypy`
# is on PATH and runnable; set this to `false` to opt out (for example,
# when a stale `protoc-gen-mypy` is installed but `mypy_protobuf` is not
# importable in the build environment).
# mypy = false

# Optionally, set the specific protoc version to use:
protoc_version = '25.1'

# Optionally, set a proto file search path (`--proto_path` or `-I` option to protoc)
proto_path = "src"

GitHub actions

To install protoc in a GitHub action, you can use the setup-protoc action:

- name: Install Protoc
  uses: arduino/setup-protoc@v2