pyease-grpc
Easy to use gRPC-web client in python
Tutorial
This package provides a requests like interface to make calls to gRPC-Web servers.
Installation
Install the package using:
$ pip install pyease-grpc
Run the following to check if it has been installed correctly:
$ pyease-grpc --version
Introduction
To use it, you need to have a basic understanding of how gRPC works.
Let's run the server first. There is an example project here: https://github.com/dipu-bd/grpc-web-example
Clone it and follow the instructions on the README.md to start the server.
Let' check the example folder for the time_service.proto file:
// file: time_service.proto
syntax = "proto3";
package smpl.time.api.v1;
option go_package = "github.com/kostyay/grpc-web-example/api/time/v1";
message GetCurrentTimeRequest {
}
message GetCurrentTimeResponse {
string current_time = 1;
}
service TimeService {
rpc GetCurrentTime(GetCurrentTimeRequest) returns (GetCurrentTimeResponse);
}
Suppose the gRPC web server is running at http://localhost:8080.
To make a request to GetCurrentTime:
from pyease_grpc import Protobuf, RpcSession
from pyease_grpc.rpc_uri import RpcUri
protobuf = Protobuf.from_file('time_service.proto')
session = RpcSession(protobuf)
response = session.request(
RpcUri('http://localhost:8080', package='smpl.time.api.v1',
service='TimeService', method='GetCurrentTime'),
{},
)
response.raise_for_status()
result = response.single
print(result['currentTime'])
The session.request accepts a dict as input and returns the response as dict.
Descriptor
A more convenient way to use the client is directly using the FileDescriptorSet.
To generate FileDescriptorSet as json:
$ pyease-grpc -I example example/time_service.proto --output example/descriptor.json
Now you can use this descriptor file directly to create Protobuf instance.
import json
with open('descriptor.json', 'r') as f:
descriptor = json.load(f)
# Use the descriptor directly to create protobuf instance
protobuf = Protobuf.restore(descriptor)
# You can even create the session directly
session = RpcSession.from_descriptor(descriptor)
13 Dec 15, 2022
39 Dec 22, 2022
1 Jan 29, 2022
4 Jul 3, 2022
1 Oct 25, 2021
1 Oct 30, 2021
1 Nov 2, 2021
1 Nov 13, 2021
1 Nov 11, 2021
36 Dec 24, 2022
401 Dec 11, 2022
45 Nov 17, 2022
3 Aug 03, 2022
119 Dec 27, 2022
18 Dec 16, 2022
29 Aug 29, 2022
3 Jan 24, 2022
1 Jan 03, 2022
3 May 22, 2022
0 Oct 08, 2022
27 Nov 22, 2022
1 Dec 24, 2022
2 Aug 19, 2022
5 Aug 02, 2022
0 Jan 05, 2023
1.1k Jan 02, 2023
11 Dec 08, 2022
20 Dec 16, 2022
1 Sep 21, 2022