Plugin for setuptools and grpc / protobuf python module build
Project description
Plugin for setuptools to compile protobuf and gRPC service files to python modules.
Usage
This package provides build_grpc command.
Run python setup.py build_grpc for available options.
Options
Command build_grpc provides following options:
proto_files: Newline separated list of glob patterns matching protobuf files to be compiled. Paths are relative to the current directory. ** can be used to match any files and zero or more directories. Default value is empty list.
grpc_files: Newline separated list of glob patterns matching grpc service files to be compiled. Paths are relative to the current directory. ** can be used to match any files and zero or more directories. Default value is empty list.
proto_path: Path to root directory with protobuf files. This path is passed through -I option to grpc_tools.protoc. Default is . (current directory).
output_path: Path to root directory for generated python modules. This path is passed through --python_out or --grpc_python_out option to grpc_tools.protoc. Default is . (current directory).
Example
# pyproject.toml
[build-system]
requires = ["setuptools", "setuptools-grpc"]
build-backend = "setuptools.build_meta"
# setup.py
from distutils.command.build import build
from setuptools import setup
class custom_build(build):
sub_commands = [
('build_grpc', None),
] + build.sub_commands
setup(cmdclass={'build': custom_build})
# setup.cfg
[build_grpc]
proto_files = src/**/*.proto
grpc_files = src/**/*_grpc.proto
proto_path = ./src
output_path = ./out
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for setuptools_grpc-0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8dd67a0b6ffdcb122906d2ac33e41bb68f50483f71de94797a3835a6b3c47406 |
|
MD5 | fa99fd41f68efc49097dd2af93544c22 |
|
BLAKE2b-256 | 97ad3b54213adf97f39142ef933607757a06ee8cd889c37f01c6a3c21f59f4da |