envoy-server 1.36.2.post1__tar.gz

envoy_server-1.36.2.post1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) CurioSwitch (oss@curioswitch.org)
+
+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_server-1.36.2.post1/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.4
+Name: envoy-server
+Version: 1.36.2.post1
+Summary: A Python wheel distribution of the Envoy server
+Keywords: envoy
+Author: CurioSwitch
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: Proxy Servers
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.10
+Project-URL: Changelog, https://github.com/curioswitch/py-envoy-server/releases
+Project-URL: Homepage, https://github.com/curioswitch/py-envoy-server
+Project-URL: Issues, https://github.com/curioswitch/py-envoy-server/issues
+Project-URL: Repository, https://github.com/curioswitch/py-envoy-server.git
+Description-Content-Type: text/markdown
+
+# envoy-server
+
+A Python package containing a runnable [Envoy](https://github.com/envoyproxy/envoy) command.
+
+On platforms supported natively by Envoy, typically glibc Linux or macOS on arm64, the package
+embeds the Envoy binary itself and runs it directly. On other platforms such as Windows, it runs
+the official [Envoy docker image](https://hub.docker.com/r/envoyproxy/envoy) - Docker must be installed
+to run. The Docker fallback is primarily meant for non-production usage, for example when your
+project runs Envoy on Linux in production but should still be runnable on a Windows developer
+machine.
+
+## Usage
+
+```bash
+uv add envoy-server # or pip install
+```
+
+The package defines a script named `envoy` which will be available on the `PATH` as normal and can
+then be run as you need.
+
+```bash
+uv run envoy --version # or just envoy if in the system Python or an activated virtualenv
+```
+
+The path to the actual binary can be found with `get_envoy_path` for use with e.g., `subprocess` in Python code.
+
+```python
+import subprocess
+
+from envoy import get_envoy_path
+
+subprocess.run([get_envoy_path(), "--version"], check=True)
+```

envoy_server-1.36.2.post1/README.md

@@ -0,0 +1,33 @@
+# envoy-server
+
+A Python package containing a runnable [Envoy](https://github.com/envoyproxy/envoy) command.
+
+On platforms supported natively by Envoy, typically glibc Linux or macOS on arm64, the package
+embeds the Envoy binary itself and runs it directly. On other platforms such as Windows, it runs
+the official [Envoy docker image](https://hub.docker.com/r/envoyproxy/envoy) - Docker must be installed
+to run. The Docker fallback is primarily meant for non-production usage, for example when your
+project runs Envoy on Linux in production but should still be runnable on a Windows developer
+machine.
+
+## Usage
+
+```bash
+uv add envoy-server # or pip install
+```
+
+The package defines a script named `envoy` which will be available on the `PATH` as normal and can
+then be run as you need.
+
+```bash
+uv run envoy --version # or just envoy if in the system Python or an activated virtualenv
+```
+
+The path to the actual binary can be found with `get_envoy_path` for use with e.g., `subprocess` in Python code.
+
+```python
+import subprocess
+
+from envoy import get_envoy_path
+
+subprocess.run([get_envoy_path(), "--version"], check=True)
+```

envoy_server-1.36.2.post1/envoy/__init__.py

@@ -0,0 +1,5 @@
+from __future__ import annotations
+
+__all__ = ["get_envoy_path"]
+
+from ._envoy import get_envoy_path

envoy_server-1.36.2.post1/envoy/_docker.py

@@ -0,0 +1,105 @@
+from __future__ import annotations
+
+import argparse
+import os
+import shutil
+from importlib import metadata
+from pathlib import Path
+
+
+class EnvoyArgs:
+    """Subset of Envoy arguments pointing to filesystem paths we need to mount in Docker."""
+
+    config_path: str
+    admin_address_path: str
+    base_id_path: str
+    log_path: str
+    socket_path: str
+
+
+def run_with_docker() -> None:
+    """Runs Envoy using Docker, for platforms not natively supported such as Windows.
+
+    This is meant to allow executing Envoy, not to isolate it, so we keep networking
+    simplest by using host networking without port mapping and mounting any referenced
+    paths rw.
+    """
+
+    docker_path = shutil.which("docker")
+    if not docker_path:
+        msg = (
+            "This platform requires Docker to run Envoy, but Docker could not be found. "
+            "Ensure it is installed and available."
+        )
+        raise RuntimeError(msg)
+
+    parser = argparse.ArgumentParser()
+    parser.add_argument("-c", "--config-path", type=str, default="")
+    parser.add_argument("--admin-address-path", type=str, default="")
+    parser.add_argument("--base-id-path", type=str, default="")
+    parser.add_argument("--log-path", type=str, default="")
+    parser.add_argument("--socket-path", type=str, default="")
+
+    volume_mounts: list[str] = []
+
+    paths, envoy_args = parser.parse_known_args(namespace=EnvoyArgs())
+    _handle_path(
+        "admin-address-path", paths.admin_address_path, volume_mounts, envoy_args
+    )
+    _handle_path("base-id-path", paths.base_id_path, volume_mounts, envoy_args)
+    _handle_path("config-path", paths.config_path, volume_mounts, envoy_args)
+    _handle_path("log-path", paths.log_path, volume_mounts, envoy_args)
+    _handle_path("socket-path", paths.socket_path, volume_mounts, envoy_args)
+
+    version = metadata.version("envoy-server")
+    if (post_idx := version.find(".post")) >= 0:
+        version = version[:post_idx]
+
+    docker_cmd = [
+        "docker",
+        "run",
+        "--rm",
+        "--network",
+        "host",
+        *volume_mounts,
+        f"envoyproxy/envoy:distroless-v{version}",
+        *envoy_args,
+    ]
+    os.execv(docker_path, docker_cmd)  # noqa: S606
+
+
+def _handle_path(
+    arg_name: str, path_str: str | None, volume_mounts: list[str], args: list[str]
+) -> None:
+    if not path_str:
+        return
+
+    path = Path(path_str).resolve()
+
+    # All of these should be files but it doesn't hurt to handle dir.
+    parent_dir = path if path.is_dir() else path.parent
+
+    if os.sep == "/":
+        # Unix-like, we can use the same path inside Docker.
+        args.extend([f"--{arg_name}", str(path)])
+        volume_mounts.append(f"-v{parent_dir}:{parent_dir}:rw")
+    else:
+        # Windows, we need to convert to /c/ style path.
+        # parent_dir.drive is 'C:', 'D:', etc. - always a string ending in exactly one colon
+        drive_letter = parent_dir.drive[:-1].lower()
+        # Skip the drive and convert
+        rel_parts = parent_dir.parts[1:]
+        wsl_dir = (
+            f"/mnt/{drive_letter}/{'/'.join(rel_parts)}"
+            if rel_parts
+            else f"/mnt/{drive_letter}"
+        )
+
+        docker_path = wsl_dir if path.is_dir() else f"{wsl_dir}/{path.name}"
+
+        args.extend([f"--{arg_name}", docker_path])
+        # It should be fine using the wsl directory corresponding to the Windows folder
+        # for the host side to support vanilla docker. Docker Desktop would also allow
+        # using native paths, and while it may be commonly used, we can't really use it
+        # in CI - this should work with either.
+        volume_mounts.append(f"-v{wsl_dir}:{wsl_dir}:rw")

envoy_server-1.36.2.post1/envoy/_envoy.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+
+def get_envoy_path() -> Path:
+    return Path(__file__).parent / "_bin" / "envoy"

envoy_server-1.36.2.post1/envoy/_main.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+import os
+import sys
+
+from ._docker import run_with_docker
+from ._envoy import get_envoy_path
+
+
+def main() -> None:
+    envoy = get_envoy_path()
+    if not envoy.exists() or os.environ.get("ENVOY_SERVER_USE_DOCKER") == "true":
+        run_with_docker()
+        return
+    os.execv(envoy, sys.argv)  # noqa: S606
+
+
+if __name__ == "__main__":
+    main()

envoy_server-1.36.2.post1/pyproject.toml

@@ -0,0 +1,186 @@
+[project]
+name = "envoy-server"
+version = "1.36.2.post1"
+description = "A Python wheel distribution of the Envoy server"
+authors = [{ name = "CurioSwitch" }]
+readme = "README.md"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+keywords = ["envoy"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: MacOS :: MacOS X",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Internet :: Proxy Servers",
+    "Topic :: Internet :: WWW/HTTP :: HTTP Servers",
+    "Topic :: System :: Networking",
+]
+
+[dependency-groups]
+dev = [
+    "httpx",
+    "poethepoet",
+    "pyright[nodejs]",
+    "pytest",
+    "ruff",
+    "toml",
+    "wheel",
+]
+
+[project.urls]
+Homepage = "https://github.com/curioswitch/py-envoy-server"
+Repository = "https://github.com/curioswitch/py-envoy-server.git"
+Issues = "https://github.com/curioswitch/py-envoy-server/issues"
+Changelog = "https://github.com/curioswitch/py-envoy-server/releases"
+
+
+[project.scripts]
+envoy = "envoy._main:main"
+
+[build-system]
+requires = ["uv_build>=0.8.13,<0.9.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "envoy"
+module-root = ""
+
+[tool.ruff.format]
+skip-magic-trailing-comma = true
+docstring-code-format = true
+
+[tool.ruff.lint]
+extend-select = [
+    # Same order as listed on https://docs.astral.sh/ruff/rules/
+    "YTT",
+    "ANN",
+    "ASYNC",
+    "S",
+    "FBT",
+    "B",
+    "A",
+    "COM818", # Other comma rules are handled by formatting
+    "C4",
+    "DTZ",
+    "T10",
+    "EM",
+    "EXE",
+    "FA",
+    "ISC",
+    "ICN",
+    "LOG",
+    "G",
+    "INP",
+    "PIE",
+    "T20",
+    "PYI",
+    "PT",
+    "Q004",   # Other quote rules are handled by formatting
+    "RSE",
+    "RET",
+    # This rule is a bit strict since accessing private members within this package can be
+    # useful to reduce public API exposure. But it is important to not access private members
+    # of dependencies like httpx so we enable it and ignore the locations where we need to.
+    "SLF",
+    "SIM",
+    "SLOT",
+    "TID",
+    # TODO: Update TODOs then enable
+    # "TD",
+    "TC",
+    "ARG",
+    "PTH",
+    "FLY",
+    "I",
+    "N",
+    "PERF",
+    "E",
+    "W",
+    # TODO: Flesh out docs and enable
+    # "DOC"
+    # "D",
+    "F",
+    "PGH",
+    "PLC",
+    "PLE",
+    "PLW",
+    "UP",
+    "FURB",
+    "RUF",
+    "TRY",
+]
+
+# Document reasons for ignoring specific linting errors
+extend-ignore = [
+    # Not applicable
+    "AIR",
+    # Dangerous false positives https://github.com/astral-sh/ruff/issues/4845
+    "ERA",
+    # Not Applicable
+    "FAST",
+    # Important to call user callbacks safely
+    "BLE",
+    # stdlib includes a module named code. This is less of an issue since users need to import a module so allow it
+    "A005",
+    # TODO: Consider using copyright headers
+    "CPY",
+    # Not Applicable
+    "DJ",
+    # It's fine to have TODOs
+    "FIX",
+    # Not Applicable
+    "INT",
+    # Even prevents pytest.raises around an iteration which is too strict
+    "PT012",
+    # Triggers for protocol implementations that don't need the arg too
+    "ARG002",
+    # Complexity checks usually reduce readability
+    "C90",
+    # Not Applicable
+    "NPY",
+    # Not Applicable
+    "PD",
+    # We use the Exception suffix instead
+    "N818",
+    # Handled by formatting
+    "E111",
+    "E114",
+    "E117",
+    "E501",
+    "W191",
+    # Low signal-to-noise ratio
+    "PLR",
+]
+
+typing-extensions = false
+
+[tool.ruff.lint.per-file-ignores]
+"scripts/**.py" = ["S603", "S607", "T201"]
+"**/test_*.py" = [
+    "ANN",
+    "S101",
+    "S603",
+    "S607",
+    "FBT",
+    "EM",
+    "INP",
+    "SLF",
+    "PERF",
+    "D",
+]
+
+
+[tool.ruff.lint.isort]
+required-imports = ["from __future__ import annotations"]
+split-on-trailing-comma = false