Skip to main content

No description has been added so far.

Project description

Build Status PyPI version License Documentation Status Test Coverage

This is a small script tailored to be used in CI environments and piplines to completely take care of generating typescript grpc stubs from protobuf files.

$ pip install grpc_web_proto_compile

To compile a directory with your proto files, simply run:

$ grpc_web_proto_compile path/to/your/proto/sources ./out

If you cloned the repository, the command looks like:

$ git clone https://github.com/romnnn/grpc-web-proto-compile
$ cd grpc-web-proto-compile/
$ python -m grpc_web_proto_compile.cli ./tests/sample/ ./out

See the official documentation for more information.

import grpc_web_proto_compile

Development

For detailed instructions see CONTRIBUTING.

Tests

You can run tests with

$ invoke test
$ invoke test --min-coverage=90     # Fail when code coverage is below 90%
$ invoke type-check                 # Run mypy type checks

Linting and formatting

Lint and format the code with

$ invoke format
$ invoke lint

All of this happens when you run invoke pre-commit.

Note

This project is still in the alpha stage and should not be considered production ready.

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 grpc-web-proto-compile, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size grpc_web_proto_compile-1.0.0.tar.gz (10.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page