Skip to main content
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.

Metadata

Release files for grpc-web-proto-compile 1.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for grpc-web-proto-compile 1.1.3
File Size Uploaded
grpc_web_proto_compile-1.1.3.tar.gz 7.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for grpc-web-proto-compile 1.1.3
File Interpreter ABI Platform
grpc_web_proto_compile-1.1.3-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 15.2 kB

Release files / grpc_web_proto_compile-1.1.3.tar.gz

Download URL grpc_web_proto_compile-1.1.3.tar.gz
Size 7.9 kB
Tags Source
SHA-256 checksum
How to use checksums
d30e715b276cc62228b32b27dc1b8c0407f93e6d3545755a04abe9f217b70121
BLAKE2b-256 checksum
How to use checksums
2146b2fc763d59a5cb6339e64a416da8ab59a5d75e6c6a416e43286463f856d2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

Release files / grpc_web_proto_compile-1.1.3-py2.py3-none-any.whl

Download URL grpc_web_proto_compile-1.1.3-py2.py3-none-any.whl
Size 7.2 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
da88f1cf281befcea3ee685596f10656ad3a6559cf1afd540a7a0c8cc8e9df6a
BLAKE2b-256 checksum
How to use checksums
30c831460d9b641ad839a0bc634389657e82854b29168404d3ebbf4755c50b25
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

Release history Release notifications | RSS feed

This release

1.1.3 This release

2 release files

1.1.2

2 release files

1.1.0

1 release file

1.0.0

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page