Merge pull request #102 from ngrok/bob/1.1.0

1.1.0
ngrok · Mar 5, 2024 · fc94d44 · fc94d44
2 parents 2eb52dc + 9ab88fb
commit fc94d44
Show file tree

Hide file tree

Showing 14 changed files with 77 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 1.1.0:
+
+- Add `app_protocol(string)` to http and labeled listener builders, and `app_protocol: string` as a `ngrok.forward()` argument. Setting this to "http2" will enable HTTP/2 support to the backend application.
+
 ## 1.0.0
 
 - Add policy support to Listener builders and `ngrok.forward`

diff --git a/Cargo.toml b/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 edition = "2021"
 name = "ngrok-python"
-version = "1.0.0"
+version = "1.1.0"
 description = "The ngrok Agent SDK for Python"
 
 [lib]

diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/http_listener_builder.doctree b/docs/.doctrees/http_listener_builder.doctree
diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree
diff --git a/docs/.doctrees/labeled_listener_builder.doctree b/docs/.doctrees/labeled_listener_builder.doctree
diff --git a/docs/genindex.html b/docs/genindex.html
diff --git a/docs/http_listener_builder.html b/docs/http_listener_builder.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/labeled_listener_builder.html b/docs/labeled_listener_builder.html
diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/examples/hypercorn-http2-ngrok.py b/examples/hypercorn-http2-ngrok.py
@@ -6,21 +6,26 @@
 
 config = Config()
 
+
 async def app(scope, receive, send):
-    await send({
-        'type': 'http.response.start',
-        'status': 200,
-        'headers': [
-            (b'content-type', b'text/plain'),
-        ],
-    })
-    await send({
-        'type': 'http.response.body',
-        'body': b'hello',
-    })
+    await send(
+        {
+            "type": "http.response.start",
+            "status": 200,
+            "headers": [
+                (b"content-type", b"text/plain"),
+            ],
+        }
+    )
+    await send(
+        {
+            "type": "http.response.body",
+            "body": b"hello",
+        }
+    )
 
 
 logging.basicConfig(level=logging.INFO)
 ngrok.forward(addr="localhost:8080", authtoken_from_env=True, app_protocol="http2")
 config.bind = ["localhost:8080"]
-asyncio.run(serve(app, config))
+asyncio.run(serve(app, config))
diff --git a/python/ngrok/ngrok.pyi b/python/ngrok/ngrok.pyi
@@ -69,6 +69,7 @@ class SessionBuilder:
 class HttpListenerBuilder:
     def allow_cidr(self, cidr: str) -> HttpListenerBuilder: ...
     def allow_user_agent(self, regex: str) -> HttpListenerBuilder: ...
+    def app_protocol(self, app_protocol: str) -> HttpListenerBuilder: ...
     def basic_auth(self, username: str, password: str) -> HttpListenerBuilder: ...
     def circuit_breaker(self, circuit_breaker: float) -> HttpListenerBuilder: ...
     def compression(self) -> HttpListenerBuilder: ...
@@ -112,6 +113,7 @@ class HttpListenerBuilder:
     def websocket_tcp_conversion(self) -> HttpListenerBuilder: ...
 
 class LabeledListenerBuilder:
+    def app_protocol(self, app_protocol: str) -> LabeledListenerBuilder: ...
     def label(self, label: str, value: str) -> LabeledListenerBuilder: ...
     def listen(self) -> Awaitable[Listener]: ...
     def listen_and_forward(self, url: str) -> Awaitable[Listener]: ...