Python bindings for hysteria, a feature-packed proxy & relay tool. This package provides a bridge to start hysteria client directly from Python on any platform.
Looking for Xray-core bindings? Check Xray-core-python.
See the real-world production GUI client that takes advantage of the Python binding: Furious.
To use this binding, please first make sure that:
You have to install the following tools to be able to install this package successfully.
go version
. Also, if google service is blocked in your region(such as Mainland China), you have to configure
your GOPROXY to be able to pull go packages. For Chinese users, refer to goproxy.cn for more
information.cmake --version
.A working GNU C++ compiler(i.e. GNU C++ toolchains). To check GNU C++ compiler is ready, type g++ --version
. These
tools should have been installed in Linux or macOS by default. If you don't have GNU C++ toolchains(especially for
Windows users) anyway:
pip install hysteria
>>> import hysteria
>>> help(hysteria)
Help on package hysteria:
NAME
hysteria
PACKAGE CONTENTS
hysteria
FUNCTIONS
startFromJSON(...) method of builtins.PyCapsule instance
startFromJSON(json: str, rule: str = '', mmdb: str = '') -> None
Start Hysteria client with JSON, ACL rule and MMDB
VERSION
1.3.5
This repository, including the package that distributes to pypi, contains hysteria source code that's been modified to build the binding and specific API. If without explicitly remark, the version of this package corresponds to the version of the origin source code tag, so the binding will have full features as the original go distribution will have. And due to its backward compatibility, there's no plan to generate bindings for older release of hysteria.
To make installation of this package easier, I didn't add the original hysteria source code as a submodule. To track what modifications have been made to the source code, you can compare it with the same version under Python binding and corresponding go repository.
hysteria-python works on all major platform with all Python version(Python 3).
Below are tested build in github actions.
Platform | Python 3.7-Python 3.11 |
---|---|
ubuntu 20.04 | :heavy_check_mark: |
ubuntu 22.04 | :heavy_check_mark: |
windows-2019 | :heavy_check_mark: |
windows-2022 | :heavy_check_mark: |
macos-11 | :heavy_check_mark: |
macos-12 | :heavy_check_mark: |
macos-13 | :heavy_check_mark: |
The license for this project follows its original go repository hysteria and is under MIT License.