Skip to main content

No description has been added so far.

Project description

Build Status PyPI version License 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
$ grpc_web_proto_compile --help # For a list of available options

If you cloned the repository, the command looks like:

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

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.

Source Distribution

grpc_web_proto_compile-1.1.2.tar.gz (7.9 kB view hashes)

Uploaded Source

Built Distribution

grpc_web_proto_compile-1.1.2-py2.py3-none-any.whl (7.2 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page