envoy_data_plane 0.6.1__tar.gz

envoy_data_plane-0.6.1/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2020 Vassilios Syrakis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

envoy_data_plane-0.6.1/PKG-INFO

@@ -0,0 +1,151 @@
+Metadata-Version: 2.1
+Name: envoy_data_plane
+Version: 0.6.1
+Summary: Python dataclasses for the Envoy Data-Plane-API
+License: MIT
+Author: Vasili Syrakis
+Author-email: vsyrakis@atlassian.com
+Requires-Python: >=3.7,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: betterproto (>=2.0.0b6,<3.0.0)
+Requires-Dist: grpcio-tools (>=1.43.0,<2.0.0)
+Description-Content-Type: text/markdown
+
+# 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:
+
+```shell script
+python -m pip install envoy_data_plane
+```
+
+## Installing specific XDS revisions
+
+There are branches available with compiled python protobuf files.  
+To install them, you can use the following syntax:
+
+```shell script
+pip install git+https://github.com/cetanu/envoy_data_plane@<BRANCH NAME>
+```
+
+Examples:
+
+```
+pip install git+https://github.com/cetanu/envoy_data_plane@envoy_v1.13.7
+pip install git+https://github.com/cetanu/envoy_data_plane@envoy_v1.16.2
+pip install git+https://github.com/cetanu/envoy_data_plane@envoy_v1.17.2
+pip install git+https://github.com/cetanu/envoy_data_plane@envoy_v1.18.2
+pip install git+https://github.com/cetanu/envoy_data_plane@envoy_v1.19.0
+```
+
+Not all versions may be available. Raise an issue if you need another one added.
+
+## Example
+
+```python
+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": []
+    }
+  ]
+}
+
+```
+

envoy_data_plane-0.6.1/README.md

@@ -0,0 +1,131 @@
+# 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:
+
+```shell script
+python -m pip install envoy_data_plane
+```
+
+## Installing specific XDS revisions
+
+There are branches available with compiled python protobuf files.  
+To install them, you can use the following syntax:
+
+```shell script
+pip install git+https://github.com/cetanu/envoy_data_plane@<BRANCH NAME>
+```
+
+Examples:
+
+```
+pip install git+https://github.com/cetanu/envoy_data_plane@envoy_v1.13.7
+pip install git+https://github.com/cetanu/envoy_data_plane@envoy_v1.16.2
+pip install git+https://github.com/cetanu/envoy_data_plane@envoy_v1.17.2
+pip install git+https://github.com/cetanu/envoy_data_plane@envoy_v1.18.2
+pip install git+https://github.com/cetanu/envoy_data_plane@envoy_v1.19.0
+```
+
+Not all versions may be available. Raise an issue if you need another one added.
+
+## Example
+
+```python
+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": []
+    }
+  ]
+}
+
+```

envoy_data_plane-0.6.1/pyproject.toml

@@ -0,0 +1,29 @@
+[tool.poetry]
+name = "envoy_data_plane"
+version = "0.6.1"
+description = "Python dataclasses for the Envoy Data-Plane-API"
+authors = ["Vasili Syrakis <vsyrakis@atlassian.com>"]
+license = "MIT"
+readme = "README.md"
+packages = [
+    { include = "envoy_data_plane", from = "src", format = "sdist" }
+]
+
+[tool.poetry.dependencies]
+python = "^3.7"
+betterproto = "^2.0.0b6"
+grpcio-tools = "^1.43.0"
+
+[tool.poetry.dev-dependencies]
+requests = "^2.25.1"
+structlog = "^21.1.0"
+protobuf = "^3.15.6"
+pytest = "^6.2.2"
+pytest-spec = "^3.1.0"
+grpcio = "^1.36.1"
+grpcio-tools = "^1.36.1"
+betterproto = {version = "^2.0.0b5", extras = ["compiler"]}
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"