xref: /aosp_15_r20/external/pigweed/pw_rpc/py/docs.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985) 
1.. _module-pw_rpc-py:
2
3-------------
4Python client
5-------------
6.. pigweed-module-subpage::
7   :name: pw_rpc
8
9The ``pw_rpc`` Python package makes it possible to call Pigweed RPCs from
10Python. The package includes a ``pw_rpc`` client library, as well as tools for
11creating a ``pw_rpc`` console.
12
13pw_rpc.client
14=============
15.. automodule:: pw_rpc.client
16  :members: Client, ClientImpl
17
18pw_rpc.client_utils
19===================
20.. automodule:: pw_rpc.client_utils
21  :members:
22    NoEncodingSingleChannelRpcClient,
23    RpcClient,
24
25pw_rpc.callback_client
26======================
27.. automodule:: pw_rpc.callback_client
28  :members:
29    UnaryResponse,
30    StreamResponse,
31    UnaryCall,
32    ServerStreamingCall,
33    ClientStreamingCall,
34    BidirectionalStreamingCall,
35
36pw_rpc.descriptors
37==================
38.. automodule:: pw_rpc.descriptors
39  :members:
40    Channel,
41    ChannelManipulator,
42
43pw_rpc.console_tools
44====================
45.. automodule:: pw_rpc.console_tools
46  :members:
47     ClientInfo,
48     Context,
49     Watchdog,
50     alias_deprecated_command,
51     flattened_rpc_completions,
52     help_as_repr,
53