sing-box-python 1.13.18__tar.gz

sing_box_python-1.13.18/CMakeLists.txt

@@ -0,0 +1,74 @@
+cmake_minimum_required(VERSION 3.15)
+project(singbox_native C CXX)
+
+set(CMAKE_C_STANDARD 99)
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+set(PYBIND11_FINDPYTHON ON)
+
+find_package(pybind11 CONFIG REQUIRED)
+
+if(NOT SINGBOX_ARCHIVE)
+    message(FATAL_ERROR "SINGBOX_ARCHIVE must name the Go c-archive")
+endif()
+if(NOT SINGBOX_INCLUDE_DIR)
+    message(FATAL_ERROR "SINGBOX_INCLUDE_DIR must name the generated-header directory")
+endif()
+
+pybind11_add_module(_native src/singbox.cpp)
+target_include_directories(_native PRIVATE "${SINGBOX_INCLUDE_DIR}")
+
+if(WIN32)
+    if(MINGW)
+        target_compile_options(_native PRIVATE "-Wa,-mbig-obj")
+        target_link_options(
+            _native PRIVATE
+            "-static-libgcc" "-static-libstdc++"
+            "-Wl,-Bstatic,--whole-archive"
+            "-lwinpthread"
+            "-Wl,--no-whole-archive"
+        )
+    endif()
+    target_link_libraries(_native PRIVATE "${SINGBOX_ARCHIVE}")
+else()
+    target_link_libraries(_native PRIVATE "${SINGBOX_ARCHIVE}" "-lresolv")
+
+    if(APPLE AND SINGBOX_CRONET_ARCHIVE)
+        # Chromium's archive includes a private libc++/libc++abi. Keep it in a
+        # separate image so its exception runtime cannot interpose pybind11's.
+        add_library(cronet SHARED src/cronet.c)
+        set_target_properties(cronet PROPERTIES OUTPUT_NAME cronet)
+        target_link_options(
+            cronet PRIVATE
+            "-Wl,-force_load,${SINGBOX_CRONET_ARCHIVE}"
+        )
+        target_link_libraries(
+            cronet PRIVATE
+            "-lbsm"
+            "-lpmenergy"
+            "-lpmsample"
+            "-lresolv"
+            "-framework AppKit"
+            "-framework ApplicationServices"
+            "-framework CFNetwork"
+            "-framework CoreFoundation"
+            "-framework CoreGraphics"
+            "-framework CoreServices"
+            "-framework CoreText"
+            "-framework CryptoTokenKit"
+            "-framework Foundation"
+            "-framework IOKit"
+            "-framework LocalAuthentication"
+            "-framework Network"
+            "-framework OpenDirectory"
+            "-framework Security"
+            "-framework SystemConfiguration"
+            "-framework UniformTypeIdentifiers"
+        )
+        add_dependencies(_native cronet)
+    endif()
+endif()
+
+if(SINGBOX_CRONET_SHARED)
+    target_compile_definitions(_native PRIVATE SINGBOX_CRONET_SHARED=1)
+endif()

sing_box_python-1.13.18/LICENSE

@@ -0,0 +1,17 @@
+Copyright (C) 2022 by nekohasekai <contact-sagernet@sekai.icu>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+In addition, no derivative work may use the name or imply association
+with this application without prior consent.

sing_box_python-1.13.18/MANIFEST.in

@@ -0,0 +1,9 @@
+recursive-include singbox *.py *.pyi py.typed
+recursive-include singbox-go *
+recursive-include src *.c *.cpp
+recursive-include tests *.py
+include CMakeLists.txt
+include LICENSE
+include README.md
+include pyproject.toml
+include setup.py

sing_box_python-1.13.18/PKG-INFO

@@ -0,0 +1,196 @@
+Metadata-Version: 2.4
+Name: sing-box-python
+Version: 1.13.18
+Summary: Python binding for sing-box
+License: GPL-3.0-or-later
+Project-URL: Source, https://github.com/LorenEteval/sing-box-python
+Project-URL: sing-box, https://github.com/SagerNet/sing-box
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: C++
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Topic :: Internet :: Proxy Servers
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-python
+Dynamic: summary
+
+# sing-box-python
+
+[![Build and publish Python distributions](https://github.com/LorenEteval/sing-box-python/actions/workflows/build-and-publish.yml/badge.svg?branch=main)](https://github.com/LorenEteval/sing-box-python/actions/workflows/build-and-publish.yml)
+
+Python bindings for [sing-box](https://github.com/SagerNet/sing-box).
+
+## Install
+
+Prebuilt binary wheels include the native Go and C++ binding, so a supported installation does not require Go, CMake,
+or a C++ compiler.
+
+```
+pip install sing-box-python
+```
+
+Binary wheels are published for Linux x86-64 and ARM64, Windows x86-64 and ARM64, and macOS Intel and Apple Silicon.
+
+### Build from Source
+
+A source distribution is also published as a fallback. If pip cannot find a compatible wheel, it may build the native
+binding from source. A source build requires:
+
+* [Go 1.24.7](https://go.dev/doc/install) in `PATH`.
+* A working C and C++ compiler toolchain.
+* MinGW-w64 on Windows x86-64, or LLVM-MinGW on Windows ARM64, with `gcc` and `g++` available in `PATH`.
+
+The isolated Python build environment installs CMake, pybind11, setuptools, and wheel automatically. To build directly
+from a repository checkout:
+
+```
+pip install .
+```
+
+The build downloads sing-box's checksum-pinned, platform-specific Cronet Go module automatically. Wheels contain an
+isolated Cronet runtime (`libcronet.dylib`, `libcronet.so`, or `libcronet.dll`), loaded from an absolute package path
+during import. On macOS the build converts the pinned static archive into a separate dynamic library so Chromium's
+private C++ runtime cannot conflict with pybind11.
+
+## API
+
+```pycon
+>>> import singbox
+>>> help(singbox)
+Help on package singbox:
+
+NAME
+    singbox - Native Python bindings for starting and managing sing-box.
+
+PACKAGE CONTENTS
+    _native
+
+CLASSES
+    builtins.RuntimeError(builtins.Exception)
+        singbox._native.SingBoxError
+    pybind11_builtins.pybind11_object(builtins.object)
+        singbox._native.SingBox
+
+    class SingBox(pybind11_builtins.pybind11_object)
+     |  An explicitly managed, non-blocking in-process sing-box instance.
+     |
+     |  Unlike the module-level startFromJSON function, this class reports startup
+     |  errors as Python exceptions and does not wait for operating-system signals.
+     |  Call stop explicitly or use the instance as a context manager.
+     |
+     |  Methods defined here:
+     |
+     |  __enter__(...)
+     |      __enter__(self: singbox._native.SingBox) -> singbox._native.SingBox
+     |
+     |      Return this instance for use as a context manager.
+     |
+     |  __exit__(...)
+     |      __exit__(self: singbox._native.SingBox, arg0: object, arg1: object, arg2: object) -> None
+     |
+     |      Stop the instance when leaving a context-manager block.
+     |
+     |  __init__(...)
+     |      __init__(self: singbox._native.SingBox) -> None
+     |
+     |      Create a stopped sing-box instance.
+     |
+     |  queryStats(...)
+     |      queryStats(self: singbox._native.SingBox, patterns: collections.abc.Sequence[str] = [], reset: bool = False, regexp: bool = False) -> dict
+     |
+     |      Return available runtime, Clash, and V2Ray statistics as a dictionary.
+     |
+     |      patterns filters V2Ray counters. reset clears matched V2Ray counters after
+     |      reading, and regexp interprets patterns as regular expressions. Clash and
+     |      V2Ray sections are None when their corresponding sing-box services are not
+     |      enabled by the configuration. Runtime memory counters are always present.
+     |
+     |  startFromJSON(...)
+     |      startFromJSON(self: singbox._native.SingBox, json: str) -> None
+     |
+     |      Start this instance from a UTF-8 JSON configuration string.
+     |
+     |      The call returns after the service starts. Invalid configuration, construction,
+     |      or startup errors raise SingBoxError. Starting an already-running instance
+     |      raises RuntimeError.
+     |
+     |  stop(...)
+     |      stop(self: singbox._native.SingBox) -> None
+     |
+     |      Stop the instance and release its native resources; repeated calls are safe.
+     |
+     |  Readonly properties defined here:
+     |
+     |  handle
+     |      Opaque numeric instance identifier, or 0 while stopped.
+     |
+     |  running
+     |      Whether this instance currently owns a running native service.
+
+    class SingBoxError(builtins.RuntimeError)
+     |  An error reported by the managed sing-box native lifecycle API.
+
+FUNCTIONS
+    startFromJSON(...) method of pybind11_builtins.pybind11_detail_function_record instance
+        startFromJSON(json: str) -> None
+
+        Start sing-box from JSON and block until SIGINT or SIGTERM is received.
+
+        This process-oriented entry point is intended to be the target of a
+        multiprocessing.Process. Configuration decoding or construction failures exit
+        the process with status 23. Service startup failures call os.Exit(-1), whose
+        observed status is platform-dependent. Use SingBox for exception-based,
+        non-blocking in-process lifecycle management.
+
+DATA
+    __all__ = ['SingBox', 'SingBoxError', '__version__', 'startFromJSON']
+
+VERSION
+    v1.13.18
+```
+
+## Source Code Modification
+
+This repository, including the package that distributes to pypi,
+contains [sing-box](https://github.com/SagerNet/sing-box) source code and the additional binding code required to build
+the Python extension and its API.
+
+To make installation of this package easier, the original [sing-box](https://github.com/SagerNet/sing-box) source code
+is embedded instead of being added as a submodule. The official source files are unchanged. The binding is implemented
+by the added `singbox-go/binding` package and the C++/Python packaging files in this repository. To track the difference,
+compare `singbox-go` with the upstream commit while excluding the added `binding` directory.
+
+## Binary Wheel Platforms
+
+The distributions are built and tested in [GitHub Actions](https://github.com/LorenEteval/sing-box-python/actions).
+
+| Platform | Architecture | CPython |
+|----------|--------------|---------|
+| Linux | x86-64 | 3.8-3.14, 3.13t, 3.14t |
+| Linux | ARM64 | 3.8-3.14, 3.13t, 3.14t |
+| Windows | x86-64 | 3.8-3.14, 3.13t, 3.14t |
+| Windows | ARM64 | 3.9-3.14, 3.13t, 3.14t |
+| macOS | Intel | 3.8-3.14, 3.13t, 3.14t |
+| macOS | Apple Silicon | 3.8-3.14, 3.13t, 3.14t |
+
+Naive outbound is included on all wheel platforms in the table. Cronet is bundled as an isolated shared runtime on
+macOS, Linux, and Windows. The macOS runtime is produced from the pinned static archive during the wheel build. The
+Cronet artifact comes from the platform module and exact version already pinned by sing-box v1.13.18's `go.mod` and
+verified by `go.sum`; the workflow does not build an unrelated Cronet revision.
+Custom source builds can override the complete sing-box tag list with the `SINGBOX_BUILD_TAGS` environment variable.
+
+## License
+
+The license for this project follows its original Go repository [sing-box](https://github.com/SagerNet/sing-box)
+and is under [GNU GPL v3 or later](https://github.com/LorenEteval/sing-box-python/blob/main/LICENSE).

sing_box_python-1.13.18/README.md

@@ -0,0 +1,169 @@
+# sing-box-python
+
+[![Build and publish Python distributions](https://github.com/LorenEteval/sing-box-python/actions/workflows/build-and-publish.yml/badge.svg?branch=main)](https://github.com/LorenEteval/sing-box-python/actions/workflows/build-and-publish.yml)
+
+Python bindings for [sing-box](https://github.com/SagerNet/sing-box).
+
+## Install
+
+Prebuilt binary wheels include the native Go and C++ binding, so a supported installation does not require Go, CMake,
+or a C++ compiler.
+
+```
+pip install sing-box-python
+```
+
+Binary wheels are published for Linux x86-64 and ARM64, Windows x86-64 and ARM64, and macOS Intel and Apple Silicon.
+
+### Build from Source
+
+A source distribution is also published as a fallback. If pip cannot find a compatible wheel, it may build the native
+binding from source. A source build requires:
+
+* [Go 1.24.7](https://go.dev/doc/install) in `PATH`.
+* A working C and C++ compiler toolchain.
+* MinGW-w64 on Windows x86-64, or LLVM-MinGW on Windows ARM64, with `gcc` and `g++` available in `PATH`.
+
+The isolated Python build environment installs CMake, pybind11, setuptools, and wheel automatically. To build directly
+from a repository checkout:
+
+```
+pip install .
+```
+
+The build downloads sing-box's checksum-pinned, platform-specific Cronet Go module automatically. Wheels contain an
+isolated Cronet runtime (`libcronet.dylib`, `libcronet.so`, or `libcronet.dll`), loaded from an absolute package path
+during import. On macOS the build converts the pinned static archive into a separate dynamic library so Chromium's
+private C++ runtime cannot conflict with pybind11.
+
+## API
+
+```pycon
+>>> import singbox
+>>> help(singbox)
+Help on package singbox:
+
+NAME
+    singbox - Native Python bindings for starting and managing sing-box.
+
+PACKAGE CONTENTS
+    _native
+
+CLASSES
+    builtins.RuntimeError(builtins.Exception)
+        singbox._native.SingBoxError
+    pybind11_builtins.pybind11_object(builtins.object)
+        singbox._native.SingBox
+
+    class SingBox(pybind11_builtins.pybind11_object)
+     |  An explicitly managed, non-blocking in-process sing-box instance.
+     |
+     |  Unlike the module-level startFromJSON function, this class reports startup
+     |  errors as Python exceptions and does not wait for operating-system signals.
+     |  Call stop explicitly or use the instance as a context manager.
+     |
+     |  Methods defined here:
+     |
+     |  __enter__(...)
+     |      __enter__(self: singbox._native.SingBox) -> singbox._native.SingBox
+     |
+     |      Return this instance for use as a context manager.
+     |
+     |  __exit__(...)
+     |      __exit__(self: singbox._native.SingBox, arg0: object, arg1: object, arg2: object) -> None
+     |
+     |      Stop the instance when leaving a context-manager block.
+     |
+     |  __init__(...)
+     |      __init__(self: singbox._native.SingBox) -> None
+     |
+     |      Create a stopped sing-box instance.
+     |
+     |  queryStats(...)
+     |      queryStats(self: singbox._native.SingBox, patterns: collections.abc.Sequence[str] = [], reset: bool = False, regexp: bool = False) -> dict
+     |
+     |      Return available runtime, Clash, and V2Ray statistics as a dictionary.
+     |
+     |      patterns filters V2Ray counters. reset clears matched V2Ray counters after
+     |      reading, and regexp interprets patterns as regular expressions. Clash and
+     |      V2Ray sections are None when their corresponding sing-box services are not
+     |      enabled by the configuration. Runtime memory counters are always present.
+     |
+     |  startFromJSON(...)
+     |      startFromJSON(self: singbox._native.SingBox, json: str) -> None
+     |
+     |      Start this instance from a UTF-8 JSON configuration string.
+     |
+     |      The call returns after the service starts. Invalid configuration, construction,
+     |      or startup errors raise SingBoxError. Starting an already-running instance
+     |      raises RuntimeError.
+     |
+     |  stop(...)
+     |      stop(self: singbox._native.SingBox) -> None
+     |
+     |      Stop the instance and release its native resources; repeated calls are safe.
+     |
+     |  Readonly properties defined here:
+     |
+     |  handle
+     |      Opaque numeric instance identifier, or 0 while stopped.
+     |
+     |  running
+     |      Whether this instance currently owns a running native service.
+
+    class SingBoxError(builtins.RuntimeError)
+     |  An error reported by the managed sing-box native lifecycle API.
+
+FUNCTIONS
+    startFromJSON(...) method of pybind11_builtins.pybind11_detail_function_record instance
+        startFromJSON(json: str) -> None
+
+        Start sing-box from JSON and block until SIGINT or SIGTERM is received.
+
+        This process-oriented entry point is intended to be the target of a
+        multiprocessing.Process. Configuration decoding or construction failures exit
+        the process with status 23. Service startup failures call os.Exit(-1), whose
+        observed status is platform-dependent. Use SingBox for exception-based,
+        non-blocking in-process lifecycle management.
+
+DATA
+    __all__ = ['SingBox', 'SingBoxError', '__version__', 'startFromJSON']
+
+VERSION
+    v1.13.18
+```
+
+## Source Code Modification
+
+This repository, including the package that distributes to pypi,
+contains [sing-box](https://github.com/SagerNet/sing-box) source code and the additional binding code required to build
+the Python extension and its API.
+
+To make installation of this package easier, the original [sing-box](https://github.com/SagerNet/sing-box) source code
+is embedded instead of being added as a submodule. The official source files are unchanged. The binding is implemented
+by the added `singbox-go/binding` package and the C++/Python packaging files in this repository. To track the difference,
+compare `singbox-go` with the upstream commit while excluding the added `binding` directory.
+
+## Binary Wheel Platforms
+
+The distributions are built and tested in [GitHub Actions](https://github.com/LorenEteval/sing-box-python/actions).
+
+| Platform | Architecture | CPython |
+|----------|--------------|---------|
+| Linux | x86-64 | 3.8-3.14, 3.13t, 3.14t |
+| Linux | ARM64 | 3.8-3.14, 3.13t, 3.14t |
+| Windows | x86-64 | 3.8-3.14, 3.13t, 3.14t |
+| Windows | ARM64 | 3.9-3.14, 3.13t, 3.14t |
+| macOS | Intel | 3.8-3.14, 3.13t, 3.14t |
+| macOS | Apple Silicon | 3.8-3.14, 3.13t, 3.14t |
+
+Naive outbound is included on all wheel platforms in the table. Cronet is bundled as an isolated shared runtime on
+macOS, Linux, and Windows. The macOS runtime is produced from the pinned static archive during the wheel build. The
+Cronet artifact comes from the platform module and exact version already pinned by sing-box v1.13.18's `go.mod` and
+verified by `go.sum`; the workflow does not build an unrelated Cronet revision.
+Custom source builds can override the complete sing-box tag list with the `SINGBOX_BUILD_TAGS` environment variable.
+
+## License
+
+The license for this project follows its original Go repository [sing-box](https://github.com/SagerNet/sing-box)
+and is under [GNU GPL v3 or later](https://github.com/LorenEteval/sing-box-python/blob/main/LICENSE).

sing_box_python-1.13.18/pyproject.toml

@@ -0,0 +1,60 @@
+[build-system]
+requires = [
+    "setuptools>=68",
+    "wheel",
+    "cmake>=3.15",
+    "pybind11>=3.0.1,<3.1; python_version == '3.8'",
+    "pybind11>=3.0.1,<4; python_version >= '3.9'",
+]
+build-backend = "setuptools.build_meta"
+
+[tool.cibuildwheel]
+build = [
+    "cp38-*",
+    "cp39-*",
+    "cp310-*",
+    "cp311-*",
+    "cp312-*",
+    "cp313-*",
+    "cp313t-*",
+    "cp314-*",
+    "cp314t-*",
+]
+enable = ["cpython-freethreading"]
+skip = "*-musllinux_*"
+build-verbosity = 1
+test-requires = ["pytest>=8"]
+test-sources = ["sample", "tests"]
+test-environment = { PYTHONSAFEPATH = "1" }
+test-command = [
+    "python sample/sample.py",
+    "pytest -q tests",
+    "python -c \"import pathlib, singbox; source = pathlib.Path(r'{project}').resolve(); installed = pathlib.Path(singbox.__file__).resolve(); assert source not in installed.parents, 'imported source checkout: ' + str(installed)\"",
+]
+
+[tool.cibuildwheel.linux]
+before-all = """
+case "$(uname -m)" in
+    x86_64)
+        go_arch='amd64'
+        go_sha256='da18191ddb7db8a9339816f3e2b54bdded8047cdc2a5d67059478f8d1595c43f'
+        ;;
+    aarch64|arm64)
+        go_arch='arm64'
+        go_sha256='fd2bccce882e29369f56c86487663bb78ba7ea9e02188a5b0269303a0c3d33ab'
+        ;;
+    *)
+        echo "Unsupported Linux architecture: $(uname -m)" >&2
+        exit 1
+        ;;
+esac
+go_archive="/tmp/go1.24.7.linux-${go_arch}.tar.gz"
+curl -fsSLo "${go_archive}" "https://go.dev/dl/go1.24.7.linux-${go_arch}.tar.gz"
+echo "${go_sha256}  ${go_archive}" | sha256sum -c -
+tar -C /usr/local -xzf "${go_archive}"
+/usr/local/go/bin/go version
+"""
+environment = { PATH = "/usr/local/go/bin:$PATH", GOTOOLCHAIN = "local" }
+
+[tool.cibuildwheel.macos]
+environment = { MACOSX_DEPLOYMENT_TARGET = "12.0", GOTOOLCHAIN = "local" }

sing_box_python-1.13.18/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+