Skip to main content

compile all protobuf files and create a single package distribution for can be installed with pip

Project description

python protobuf compiler

compile all protobuf files and create a single package distribution for can be installed with pip

requirements

  • python >= 3.6
  • git (only for build from git repository)

features

  • [x] support for multiples folders
  • [x] support multiples proto files
  • [x] Create self package for pip
  • [x] Support for build from github and gitlab repository
  • [X] Support for build from local directory
  • [X] support imports into proto file (see test folder for show example )

install

pip3 install protobuf-compiler

for check install, execute in your terminal:

protopy -h

arguments

  • -h, --help : show this help message and exit
  • -d PROTO_DIR, --dir PROTO_DIR : folder path where the .proto files are located
  • -p PACKAGE_NAME, --package PACKAGE_NAME : package name
  • -o OUTPUT_DIR, --output OUTPUT_DIR: output folder for save single package .tar.gz
  • -g URL, --git URL : git reopsitory url where the .proto files are located
  • -t TOKEN, --token TOKEN : git server api token
  • -v VERSION, --version VERSION : tag version for build package

usage

protopy [-h] [-d PROTO_DIR] [-p PACKAGE_NAME] [-o OUTPUT_DIR]

example

  • compile from git repository:

you can clone a git repository from gitlab and github

python3 -m protopy -o /my/target/dir -p testpackage -g https://github.com/netsaj/testing.git -t my-private-token
  • compile from folder:
python3 -m protopy -o /my/output/dir -p testpackage -d /my/protofile/source/dir 

install generate package in your app

run in your app folder:

pip3 install /my/output/dir/package-version.tar.gz

example:

  • installing generate package:
pip3 install /Users/netsaj/temp/mytest-1.0.0.tar.gz
  • import into you .py files:
from mytest.analytics import analytics_pb2

Authors

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for protobuf-compiler, version 1.0.20
Filename, size File type Python version Upload date Hashes
Filename, size protobuf_compiler-1.0.20-py3-none-any.whl (8.6 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size protobuf_compiler-1.0.20.tar.gz (5.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page