Skip to content

Latest commit

 

History

History
102 lines (71 loc) · 4.23 KB

README.md

File metadata and controls

102 lines (71 loc) · 4.23 KB
Raw

grpc_requests

Nox Ruff Checked with mypy PyPI PyPI - Python Version PyPI download month License Views

GRPC for Humans

Leverage reflection to interact with GRPC in a familiar manner for users of the requests library.

from grpc_requests import Client

client = Client.get_by_endpoint("localhost:50051")
assert client.service_names == ["helloworld.Greeter"]

request_data = {"name": "sinsky"}
say_hello_response = client.request("helloworld.Greeter", "SayHello", request_data)
assert say_hello_response ==  {"message":"Hello sinsky!"}

Features

  • Create a client easily when connecting to servers implementing grpc reflection
  • Still support creating a client from stubs when reflection isn't available
  • All unary and stream methods supported
  • TLS and compression connections supported
  • AsyncIO API supported

Install

pip install grpc_requests

Usage

In short:

Instantiate a client using the URL of a GRPC server and any authentication credentials you may need. If the server utilizes SSL (and it probably does) make sure to toggle that flag.

from grpc_requests import Client

metadata = [("authorization", "bearer my.cool.jwt")]
client = Client.get_by_endpoint("cool.servers.arecool:443", ssl=True, metadata=metadata)

The examples page provides more thorough examples of usage scenarioes, and the unit tests are also a useful reference point.

Contributing

Contributions from the community are welcomed and greatly appreciated.

Before opening a PR, running python -m nox can be used to ensure the contribution passes linting and unit test checks for all supported versions of Python and protobuf. You can also run complexity.sh to use radon to look at the cyclomatic complexity, maintainability index, and Halstead effort and difficulty of files.

PRs should be targeted to merge with the develop branch. When opening a PR, please assign it to a maintainer for review. The maintainers will take it from there.

Compatibility

grpc_requests currently does its best to support versions of Python and protobuf that are within their support lifetimes. You may find that other versions of dependencies work with the library, but this should be treated as a happy accident.

For Python, we target versions that are in the security and bugfix phases. For protobuf, we target versions that in their public support phase.

Python's support matrix Protobuf's support matrix

Protobuf Compatibility

The maintainers of grpc_requests have found that protobuf 4.25.4 is not compatible with verisons >=1.66.0 of both grpcio and grpcio-reflection. If your use case needs 4.25.4 of protobuf, we recommend sticking to verison 1.65.x of grpcio and grpcio-reflection.

Questions, Comments, Issues?

For questions, please start a conversation on the discussions page!

For feature requests or bugs, please open an issue and assign it the appropriate tag.

Maintainers