Auto-generated native gRPC stubs and types for xray-core
Project description
xray-proto
Auto-generated, native Python gRPC stubs and types for Xray-core (XTLS/Xray-core).
This library provides fully compiled Python modules and static type hints (.pyi) for the entire Xray-core API, allowing seamless asynchronous or synchronous gRPC communication with an Xray daemon from Python backends.
Who is this for?
This library is designed for backend developers, infrastructure engineers, and systems administrators building tools around the Xray/V2Ray ecosystem.
- VPN Management Services: Automate user management, add/remove inbound/outbound proxies, and query active sessions dynamically.
- Monitoring & Metrics: Fetch real-time traffic statistics and system state from the Xray core daemon.
- Dynamic Routing: Modify routing rules and core behavior on the fly via high-performance gRPC calls.
Architecture & Versioning
To preserve historical accuracy and isolate dependencies, this repository adopts a one-branch-per-release strategy:
main: Contains the core compilation tools, automated GitHub Actions pipelines, and metadata configs. It does not contain generated code.release/v<Xray-Version>: Dedicated branches containing the compiled python stubs tailored strictly to that specific Xray-core release version.
The library package versions map directly to Xray-core releases using the format:
X.Y.Z.Patch (e.g., library version 24.11.30.0 maps directly to Xray-core v24.11.30).
Installation
From PyPI
You can install the official wheels compiled for stable Xray-core versions:
# Using uv (recommended)
uv add xray-proto
# Using pip
pip install xray-proto
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file xray_proto-26.3.27.0.tar.gz.
File metadata
- Download URL: xray_proto-26.3.27.0.tar.gz
- Upload date:
- Size: 88.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.17 {"installer":{"name":"uv","version":"0.9.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Pop!_OS","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b51045c3cf8808978e03f3d7846623f917846d927fa13df954cdaea6017f15f8
|
|
| MD5 |
773bf8517f7d2c5385889abccd34f633
|
|
| BLAKE2b-256 |
436e2cd1a44aff30fc41d2a6f0da2024c3e9c1707d0cf8dd7199ec093f5a2545
|
File details
Details for the file xray_proto-26.3.27.0-py3-none-any.whl.
File metadata
- Download URL: xray_proto-26.3.27.0-py3-none-any.whl
- Upload date:
- Size: 306.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.17 {"installer":{"name":"uv","version":"0.9.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Pop!_OS","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
64fe28ada3390e385d5489c421bd9303f1f6e39add55b5a5e24c5326b032957f
|
|
| MD5 |
359c9531353d1db4071464a49526a2db
|
|
| BLAKE2b-256 |
763fb065e4089be80c7138c4616abbb11f313d92539c951b214cd239d95aeef5
|