sing-box-bin 1.12.10__tar.gz

sing_box_bin-1.12.10/.github/dependabot.yml

@@ -0,0 +1,16 @@
+version: 2
+updates:
+
+  - package-ecosystem: pip
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "chore(rye)"
+
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "ci(github-actions)"

sing_box_bin-1.12.10/.github/workflows/build.yml

@@ -0,0 +1,92 @@
+name: Build sing-box
+
+on:
+  schedule:
+    - cron: '0 0 * * *'
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    outputs:
+      should_build: ${{ steps.check_version.outputs.should_build }}
+      version: ${{ steps.check_version.outputs.version }}
+      clean_version: ${{ steps.check_version.outputs.clean_version }}
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Check latest version
+        id: check_version
+        run: |
+          LATEST_TAG=$(curl -s https://api.github.com/repos/SagerNet/sing-box/releases/latest | jq -r .tag_name)
+          CLEAN_VERSION="${LATEST_TAG#v}"
+
+          echo "Upstream Tag: $LATEST_TAG"
+          echo "version=$LATEST_TAG" >> $GITHUB_OUTPUT
+          echo "clean_version=$CLEAN_VERSION" >> $GITHUB_OUTPUT
+
+          BIN_PATH="src/sing_box_bin/bin/sing-box"
+
+          # whether to build
+          if [ -f "$BIN_PATH" ]; then
+            chmod +x "$BIN_PATH"
+            CURRENT_TAG="v$($BIN_PATH version | head -n 1 | awk '{print $3}')"
+
+            echo "Current Binary Tag: $CURRENT_TAG"
+
+            if [ "$CURRENT_TAG" == "$LATEST_TAG" ]; then
+              echo "✅ Binary is up to date."
+              echo "should_build=false" >> $GITHUB_OUTPUT
+            else
+              echo "🔄 Update needed: $CURRENT_TAG -> $LATEST_TAG"
+              echo "should_build=true" >> $GITHUB_OUTPUT
+            fi
+          else
+            echo "⚠️ Binary does not exist, building fresh."
+            echo "should_build=true" >> $GITHUB_OUTPUT
+          fi
+
+  build-and-push:
+    needs: check
+    if: needs.check.outputs.should_build == 'true'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+
+      - name: Install Dependencies
+        run: sudo apt-get update && sudo apt-get install -y jq
+
+      - uses: actions/setup-go@v6
+        with:
+          go-version: 'stable'
+      - run: go version
+
+      - name: Build sing-box binaries
+        run: |
+          chmod +x scripts/build.sh
+          ./scripts/build.sh ${{ needs.check.outputs.version }}
+
+      - name: Commit New bin Files
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+          git add src/sing_box_bin/bin/
+          git add src/sing_box_bin/__init__.py
+
+          git commit -m "feat: update sing-box binary to version ${{ needs.check.outputs.version }}"
+
+      - name: Bump version
+        run: |
+          uv tool install bump-my-version
+          uv run bump-my-version bump --new-version "${{ needs.check.outputs.clean_version }}"
+
+      - name: Push Changes
+        run: git push origin main --tags

sing_box_bin-1.12.10/.github/workflows/main.yml

@@ -0,0 +1,99 @@
+name: Test And Release
+
+on:
+  push:
+    branches: [ main ]
+    tags:
+      - "v*.*.*"
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    name: Run Tests / OS ${{ matrix.os }} / Python ${{ matrix.python-version }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --python ${{ matrix.python-version }} --all-extras --dev
+
+      - name: Run Code Coverage Tests Pipeline
+        run: uv run bash scripts/pre-commit.sh
+
+  release:
+    name: Bump Version and Release
+    needs: test
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/')
+
+    permissions:
+      id-token: write # enable for OIDC [4,5]
+      contents: write
+
+    outputs:
+      version: ${{ steps.inspect_package.outputs.version }}
+      package: ${{ steps.inspect_package.outputs.package }}
+
+    environment:
+      name: pypi  # display pypi in page
+      url: https://pypi.org/project/${{ steps.inspect_package.outputs.package }}/${{ steps.inspect_package.outputs.version }}
+
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      # add trusted-publishers on pypi first[6]
+      - name: Build
+        run: uv build
+
+      - name: Inspect package version
+        id: inspect_package
+        run: |
+          version=$(uvx hatchling version)
+          echo "version=$version" >> "$GITHUB_OUTPUT"
+          package=$(uvx hatchling metadata | jq -r .name)
+          echo "package=$package" >> "$GITHUB_OUTPUT"
+
+      - name: Publish
+        run: uv publish
+
+      - name: Generate a changelog
+        env:
+          ATTICUS_PAT: ${{ secrets.ATTICUS_PAT }}
+        run: uv run git-cliff -vv --latest --strip header --github-token "$ATTICUS_PAT" -o CHANGES.md
+
+      - name: Release
+        uses: softprops/action-gh-release@v2
+        with:
+          body_path: CHANGES.md
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+# Reference
+# 1. https://docs.astral.sh/uv/guides/integration/github/#syncing-and-running
+# 2. https://github.com/Kludex/python-template/blob/main/.github/workflows/main.yml
+# 3. https://github.com/softprops/action-gh-release/tree/master/
+# 4. https://docs.github.com/en/actions/security-for-github-actions/security-hardening-your-deployments/about-security-hardening-with-openid-connect#adding-permissions-settings
+# 5. https://docs.github.com/en/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-pypi
+# 6. https://docs.pypi.org/trusted-publishers/adding-a-publisher/

sing_box_bin-1.12.10/.gitignore

@@ -0,0 +1,165 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# UV
+.ruff_cache/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+.vscode/PythonImportHelper-v2-Completion.json

sing_box_bin-1.12.10/.pre-commit-config.yaml

@@ -0,0 +1,51 @@
+# https://pre-commit.com/
+# `pre-commit install` to set up the git hook scripts
+# `pre-commit autoupdate` to update repos
+# `pre-commit run --all-files` run hooks for all file
+
+# exclude: (^|/)\..*
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-toml
+      - id: check-yaml
+        args: [--unsafe]
+      - id: sort-simple-yaml
+      - id: check-json
+      - id: pretty-format-json
+        args: [--autofix, --no-sort-keys,--no-ensure-ascii]
+      - id: check-added-large-files
+        args: [--maxkb=51200]
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: detect-private-key
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+      - id: codespell
+        args: [--write-changes]
+        files: \.(py|sh|json|yml|yaml|md)$
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.7
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    # uv version.
+    rev: 0.9.13
+    hooks:
+      # Update the uv lockfile
+      - id: uv-lock
+
+ci:
+  autofix_commit_msg: 🎨 [pre-commit.ci] Auto format from pre-commit.com hooks
+  # Settings for the https://pre-commit.ci/ continuous integration service
+  autofix_prs: true
+  autoupdate_commit_msg: ⬆ [pre-commit.ci] pre-commit autoupdate
+  autoupdate_schedule: monthly

sing_box_bin-1.12.10/.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+  "[python]": {
+    "editor.codeActionsOnSave": {
+      "source.fixAll": "explicit",
+      "source.organizeImports": "explicit"
+    },
+    "editor.formatOnSave": true
+  },
+  "files.insertFinalNewline": true,
+  "files.trimTrailingWhitespace": true
+}

sing_box_bin-1.12.10/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 A.J.Zeller
+
+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.

sing_box_bin-1.12.10/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.4
+Name: sing-box-bin
+Version: 1.12.10
+Summary: python template package
+Project-URL: Homepage, https://github.com/aittcuszz/sing-box-bin
+Project-URL: Issues, https://github.com/atticuszeller/sing-box-bin/issues
+Project-URL: documentation, https://atticuszeller.github.io/sing-box-bin/
+Project-URL: Changelog, https://github.com/atticuszeller/sing-box-bin/blob/main/CHANGELOG.md
+Author-email: "A.J.Zeller" <hello@atticux.me>
+Maintainer-email: "A.J.Zeller" <hello@atticux.me>
+License: MIT License
+        
+        Copyright (c) 2024 A.J.Zeller
+        
+        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.
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# sing-box-bin
+
+A Python wrapper for sing-box binary releases
+
+
+## build and bump version
+
+```bash
+.\scripts\build.sh "vx.y.z"
+bump-my-version bump --new-version "x.y.z"
+git push origin main --tags
+```
+
+## install
+
+```bash
+uv add sing-box-bin
+```
+
+## usage
+
+```python
+from sing_box_bin import get_bin_path
+
+>>> get_bin_path()
+>>> ./.sing-box-bin/ sing-box-windows-amd64.exe
+```

sing_box_bin-1.12.10/README.md

@@ -0,0 +1,27 @@
+# sing-box-bin
+
+A Python wrapper for sing-box binary releases
+
+
+## build and bump version
+
+```bash
+.\scripts\build.sh "vx.y.z"
+bump-my-version bump --new-version "x.y.z"
+git push origin main --tags
+```
+
+## install
+
+```bash
+uv add sing-box-bin
+```
+
+## usage
+
+```python
+from sing_box_bin import get_bin_path
+
+>>> get_bin_path()
+>>> ./.sing-box-bin/ sing-box-windows-amd64.exe
+```