Metadata-Version: 2.4
Name: sing-box-bin
Version: 1.13.1
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"
git add src/sing_box_bin/bin/
git commit -m "feat: update sing-box binary to version vx.y.z"
uv tool install bump-my-version
bump-my-version bump --new-version vx.y.z --commit --tag
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()
>>> Path(./sing-box-bin/bin/sing-box-windows-amd64.exe)
```
