ngrok-fastapi 0.1.0__py3-none-any.whl

ngrok_fastapi/__init__.py

@@ -0,0 +1,158 @@
+"""Bring ngrok Traffic Policy, pooling, and binding config to FastAPI.
+
+ngrok's own official Python tooling (`ngrok-asgi`, bundled inside `ngrok-python`) already
+wraps any ASGI app with zero code changes — that part isn't rebuilt here. What it's missing,
+confirmed by reading its entire CLI parser directly: a `--traffic-policy` flag, pooling,
+`--binding`, and any config-file support at all (`args.config` is a hard-coded fatal error).
+This library fills that gap as a small FastAPI-native alternative, using FastAPI's own
+lifespan hook instead of CLI flags — the same fork `ngrok-axum` made for Rust, for the same
+reason: per-endpoint config like a Traffic Policy document doesn't compose cleanly as a flag.
+"""
+
+from __future__ import annotations
+
+import asyncio
+from collections import defaultdict
+from contextlib import asynccontextmanager
+from dataclasses import dataclass
+from enum import Enum
+from typing import Dict, List, NamedTuple, Optional
+
+import ngrok
+from fastapi import FastAPI
+
+
+class Binding(str, Enum):
+    """Ingress configuration. Not part of ngrok's Traffic Policy — confirmed by checking
+    the Traffic Policy actions reference directly, so this stays a standalone field rather
+    than folded into `traffic_policy`."""
+
+    PUBLIC = "public"
+    # Requires `url` to end in ".internal" — enforced by ngrok itself (ERR_NGROK_9029 if it
+    # doesn't), not something this library validates.
+    INTERNAL = "internal"
+    KUBERNETES = "kubernetes"
+
+
+@dataclass
+class Config:
+    """Configuration for a single ngrok endpoint.
+
+    Deliberately minimal, same reasoning as the `ngrok-nextjs` and `ngrok-axum` sibling
+    projects: the granular per-module builder methods (`basic_auth`, `oauth`, header
+    manipulation, CIDR restrictions, etc.) mirror ngrok's old "Edge Modules" system,
+    superseded by Traffic Policy. Use `traffic_policy` for all of that instead.
+    """
+
+    # Local port this endpoint forwards to.
+    port: int = 8000
+    # Reserved domain for this endpoint. `None` falls back to the account's default dev
+    # domain.
+    url: Optional[str] = None
+    # Opt in to ngrok endpoint pooling — required if another endpoint on the same session
+    # would otherwise land on the same domain. ngrok does not reject or warn on that
+    # collision by default: confirmed live against the real SDK, independently across the
+    # JS, Rust, and Python SDKs, that two listeners opened with no domain and no pooling all
+    # succeed silently, returning the identical URL, with only the most recently opened one
+    # actually receiving traffic.
+    pooling: bool = False
+    # Raw ngrok Traffic Policy document (YAML or JSON), passed straight through. See
+    # https://ngrok.com/docs/traffic-policy/.
+    traffic_policy: Optional[str] = None
+    binding: Optional[Binding] = None
+
+
+class CollisionError(Exception):
+    """Raised before any session is opened when two or more configs would silently collide
+    on the same url without pooling enabled."""
+
+
+def _validate_configs(configs: List[Config]) -> None:
+    groups: Dict[str, List[int]] = defaultdict(list)
+    for i, config in enumerate(configs):
+        groups[config.url or ""].append(i)
+
+    for url, indices in groups.items():
+        if len(indices) <= 1:
+            continue
+        if all(configs[i].pooling for i in indices):
+            continue
+
+        label = f'"{url}"' if url else "the account's default dev domain"
+        raise CollisionError(
+            f"Configs at indices {indices} would all share {label}. Without endpoint "
+            "pooling, only the most recently opened listener actually receives traffic — "
+            "the rest go silently unreachable. Set pooling=True on each of these configs "
+            "to share it intentionally, or give each its own url."
+        )
+
+
+def _configure_builder(builder, config: Config):
+    if config.url:
+        builder = builder.domain(config.url)
+    if config.pooling:
+        builder = builder.pooling_enabled(True)
+    if config.traffic_policy:
+        builder = builder.traffic_policy(config.traffic_policy)
+    if config.binding:
+        builder = builder.binding(config.binding.value)
+    return builder
+
+
+class _OpenListener(NamedTuple):
+    listener: "ngrok.Listener"
+    forward_task: "asyncio.Future"
+
+
+async def _open_listeners(configs: List[Config]) -> List[_OpenListener]:
+    _validate_configs(configs)
+    session = await ngrok.SessionBuilder().authtoken_from_env().connect()
+
+    opened = []
+    for config in configs:
+        builder = _configure_builder(session.http_endpoint(), config)
+        listener = await builder.listen()
+        print(f"Ingress established at: {listener.url()}")
+        # listener.forward() is a long-running background operation, not a
+        # quick "set up forwarding" call — confirmed directly, isolated from
+        # FastAPI: awaiting it inline never returns even after the target
+        # port starts accepting connections. It also has to be scheduled
+        # *before* the local ASGI server has bound its own port, since this
+        # all runs during lifespan startup, which uvicorn completes *before*
+        # calling `loop.create_server()` for the app itself (confirmed by
+        # reading uvicorn's own source) — so awaiting it inline here would
+        # deadlock: forward() waiting on a port that only gets bound once
+        # this same startup sequence finishes.
+        forward_task = asyncio.ensure_future(listener.forward(f"localhost:{config.port}"))
+        opened.append(_OpenListener(listener, forward_task))
+    return opened
+
+
+def attach(app: FastAPI, config: Optional[Config] = None) -> None:
+    """Opens a single ngrok endpoint per `config` and ties its lifetime to `app`."""
+    attach_many(app, [config or Config()])
+
+
+def attach_many(app: FastAPI, configs: List[Config]) -> None:
+    """Opens one ngrok endpoint per entry in `configs`, all on a single session, and ties
+    their lifetime to `app`.
+
+    Wraps the app's existing lifespan (composing with it, not replacing it, whether the app
+    was given an explicit `lifespan=` or not) rather than using the `@app.on_event` decorators
+    — those are soft-deprecated in FastAPI in favor of the lifespan protocol, and this library
+    aims to be the modern path, not propagate the deprecated one.
+    """
+    existing_lifespan = app.router.lifespan_context
+
+    @asynccontextmanager
+    async def wrapped_lifespan(app: FastAPI):
+        opened = await _open_listeners(configs)
+        try:
+            async with existing_lifespan(app) as state:
+                yield state
+        finally:
+            for opened_listener in opened:
+                opened_listener.forward_task.cancel()
+                await opened_listener.listener.close()
+
+    app.router.lifespan_context = wrapped_lifespan

ngrok_fastapi-0.1.0.dist-info/METADATA

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: ngrok-fastapi
+Version: 0.1.0
+Summary: Bring ngrok Traffic Policy, pooling, and binding config to FastAPI, via its own lifespan hook.
+License-Expression: MIT OR Apache-2.0
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE-APACHE
+License-File: LICENSE-MIT
+Requires-Dist: ngrok>=1.4.0
+Requires-Dist: fastapi>=0.100.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.24.0; extra == "dev"
+Requires-Dist: uvicorn>=0.29.0; extra == "dev"
+Requires-Dist: httpx>=0.27.0; extra == "dev"
+Dynamic: license-file
+
+# ngrok-fastapi
+
+Bring ngrok Traffic Policy, pooling, and binding config to FastAPI — via FastAPI's own
+lifespan hook, with one call:
+
+```python
+from fastapi import FastAPI
+import ngrok_fastapi
+
+app = FastAPI()
+ngrok_fastapi.attach(app, ngrok_fastapi.Config(port=8000))
+```
+
+## What it is
+
+A small FastAPI-native ngrok library. `attach()`/`attach_many()` wrap an app's existing
+lifespan context manager so an ngrok tunnel opens when the app starts and closes when it stops. 
+
+## Setup
+
+1. Sign up at [ngrok.com](https://ngrok.com) and grab an authtoken from
+   [the dashboard](https://dashboard.ngrok.com/authtokens).
+2. Set it as an env var: `NGROK_AUTHTOKEN=your_token_here`
+3. `pip install ngrok-fastapi` and call `attach()` — see [`examples/basic.py`](examples/basic.py).
+
+## Config
+
+```python
+ngrok_fastapi.attach(app, ngrok_fastapi.Config(
+    port=8000,
+    url="your-reserved-domain.ngrok.app",  # None = account's default dev domain
+    pooling=False,
+    traffic_policy="""
+on_http_request:
+  - actions:
+      - type: basic-auth
+        config:
+          credentials:
+            - "user:password123"
+""",
+    binding=None,  # ngrok_fastapi.Binding.INTERNAL, etc.
+))
+```
+
+See [`examples/with_config.py`](examples/with_config.py) for a working example.
+
+| Field | Type | Description |
+|---|---|---|
+| `port` | `int` | Local port this endpoint forwards to. |
+| `url` | `Optional[str]` | Reserved domain for this endpoint. `None` falls back to the account's default dev domain. |
+| `pooling` | `bool` | Opt in to ngrok endpoint pooling — required if another endpoint on the same session would otherwise collide on the same domain. See [Collisions](#collisions). |
+| `traffic_policy` | `Optional[str]` | A raw [ngrok Traffic Policy](https://ngrok.com/docs/traffic-policy/) document (YAML or JSON) — the mechanism for auth, IP restrictions, header manipulation, webhook verification, and more. |
+| `binding` | `Optional[Binding]` | `PUBLIC` / `INTERNAL` / `KUBERNETES` ingress configuration. Not part of Traffic Policy (checked ngrok's actions reference directly — no equivalent exists), so it stays a standalone field. `INTERNAL` requires `url` to end in `.internal`, enforced by ngrok itself (`ERR_NGROK_9029` if it doesn't). |
+
+## Multiple endpoints
+
+`attach_many(app, configs)` opens one endpoint per `Config`, all on a single session, and
+ties all of them to the same app's lifespan. `attach(app, config)` is just
+`attach_many(app, [config])`.
+
+```python
+ngrok_fastapi.attach_many(app, [
+    ngrok_fastapi.Config(port=8000, url="app.mycompany.ngrok.app"),
+    ngrok_fastapi.Config(port=8001, url="api.mycompany.ngrok.app"),
+])
+```
+
+## Development
+
+```
+python3 -m venv venv && source venv/bin/activate
+pip install -e ".[dev]"
+pytest
+python examples/basic.py
+```
+
+See [`DESIGN.md`](DESIGN.md) for the design rationale and everything confirmed empirically
+along the way.
+
+## License
+
+MIT OR Apache-2.0

ngrok_fastapi-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+ngrok_fastapi/__init__.py,sha256=pdD6xHXz9NnLUCF_rvuF8K312DtBYIQdpNaee7VJodQ,6807
+ngrok_fastapi-0.1.0.dist-info/licenses/LICENSE-APACHE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+ngrok_fastapi-0.1.0.dist-info/licenses/LICENSE-MIT,sha256=_Qtet9ghJ90nbutkwaPn98nPao2thuiA-_0KdR-MNRA,1067
+ngrok_fastapi-0.1.0.dist-info/METADATA,sha256=DS97E70BOYbWq4U7wUa7PRDYy5iM63f0Q3JzgT82Ig0,3530
+ngrok_fastapi-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+ngrok_fastapi-0.1.0.dist-info/top_level.txt,sha256=4po_p6cYl8hRq8z2Rw0Ss6B_OhgWW08ikuyEGj6Ffq0,14
+ngrok_fastapi-0.1.0.dist-info/RECORD,,

ngrok_fastapi-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

ngrok_fastapi-0.1.0.dist-info/licenses/LICENSE-APACHE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ngrok_fastapi-0.1.0.dist-info/licenses/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ishan Jain
+
+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.

ngrok_fastapi-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+ngrok_fastapi