Python dataclasses for the Envoy Data-Plane-API
Project description
envoy_data_plane
A conversion of envoyproxy/data-plane-api protocol buffers into Python dataclasses using betterproto
Intended usage
This is a helper library that allows importing every type available in the envoy API.
One use-case might be generating Envoy configuration using a Python script.
In my case, I will use this library in my custom built control-plane, so that I have autocompletion in my IDE, and a basic form of validation.
In future, this may also help with building an idiomatic GRPC control-plane in Python.
Installation
This package is published to PyPI:
python -m pip install envoy_data_plane
Example
import stringcase
import json
import envoy_data_plane.envoy.api.v2 as envoy
route_config = envoy.RouteConfiguration(
name='MyRouteConfig',
virtual_hosts=[
envoy.route.VirtualHost(
name='SomeWebsite',
domains=['foobar.com'],
routes=[
envoy.route.Route(
name='catchall',
match=envoy.route.RouteMatch(
prefix='/'
),
direct_response=envoy.route.DirectResponseAction(
status=200,
body=envoy.core.DataSource(
inline_string='Hello there'
)
)
)
]
)
]
)
response = envoy.DiscoveryResponse(
version_info='0',
resources=[
route_config
],
)
print(
json.dumps(response.to_dict(casing=stringcase.snakecase), indent=2)
)
Result:
{
"version_info": "0",
"resources": [
{
"name": "MyRouteConfig",
"virtual_hosts": [
{
"name": "SomeWebsite",
"domains": [
"foobar.com"
],
"routes": [
{
"name": "catchall",
"match": {
"prefix": "/",
"headers": [],
"query_parameters": []
},
"direct_response": {
"status": 200,
"body": {
"inline_string": "Hello there"
}
},
"request_headers_to_add": [],
"response_headers_to_add": []
}
],
"virtual_clusters": [],
"rate_limits": [],
"request_headers_to_add": [],
"response_headers_to_add": []
}
],
"response_headers_to_add": [],
"request_headers_to_add": []
}
]
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
envoy_data_plane-0.1.0.tar.gz
(372.7 kB
view hashes)
Built Distributions
Close
Hashes for envoy_data_plane-0.1.0-py3.8.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7bd5240bd395aca03b037c5d10110c14fc9bca891c2f61340e69354a1d451041 |
|
MD5 | 6006b9f1218bcad35bde6e939893dd59 |
|
BLAKE2b-256 | 58f6418c3e13c04d7f67f9a5d730be261d8f45425d5d4bc0c3ba3a616c9be5f8 |
Close
Hashes for envoy_data_plane-0.1.0-py3.7.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 28f5ee69f611b1d1e59e9018908176a16e7cc8921b74d86fdd6594d8ba1d6efa |
|
MD5 | 61c56eea0c1e8b92076d017b42ac8b90 |
|
BLAKE2b-256 | 12798a1260c1f1a165b5c2bfad53b5dbe3e48bda020379f20609feb1a7d2694d |