Skip to main content

Simplify v2ray control with this Python package and native extensions

Project description

V2Root

A Python package to manage v2ray with native extensions.

V2Root provides a Python interface to interact with the v2ray proxy software using a custom C library (libv2root.dll). It allows users to load configurations, start/stop v2ray, test connections, and parse VLESS strings into v2ray config files.

Features

  • Load and validate v2ray configuration files
  • Start and stop v2ray processes
  • Test server connections with ping and VLESS-specific tests
  • Parse VLESS strings into v2ray-compatible JSON configs

Installation

Install via pip:

pip install v2root

Usage

Basic example to start v2ray with a VLESS configuration:

from v2root import V2ROOT

# Initialize V2ROOT
v2 = V2ROOT()

# Set a VLESS string
vless_str = "vless://your-uuid@your-server:443?security=tls&type=tcp"
v2.set_vless_string(vless_str)

# Load config and start v2ray
v2.load_config()
v2.start()

# Stop v2ray when done
v2.stop()

Requirements

  • Python 3.6 or higher
  • Windows OS (due to dependency on libv2root.dll and v2ray.exe)
  • Standard libraries: ctypes, urllib.request

License

This project is licensed under the MIT License - see the file for details.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request with your changes.

Support

If you encounter any issues or have questions, feel free to open an issue on the GitHub repository.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

v2root-1.0.0.tar.gz (13.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

v2root-1.0.0-py3-none-any.whl (13.1 MB view details)

Uploaded Python 3

File details

Details for the file v2root-1.0.0.tar.gz.

File metadata

  • Download URL: v2root-1.0.0.tar.gz
  • Upload date:
  • Size: 13.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for v2root-1.0.0.tar.gz
Algorithm Hash digest
SHA256 f156cfffb32bf8088b52ebdd8f382baddd1f20316bbfc949d05f5a738e9cfdd5
MD5 f5b48ec119d9da04389dad704d21de26
BLAKE2b-256 2bccb82fa494897e893bb72c78ca9d2359ccac251bb948269a700628688c442c

See more details on using hashes here.

File details

Details for the file v2root-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: v2root-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 13.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for v2root-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 69ea5fac1c1785a7a97dd8ffe51ba5a0df878dd3b9a789c272da10297f09c6bd
MD5 31d20799d683273deafa9544d9799721
BLAKE2b-256 a6c468d37f70b5fb3a0458eae3e00d1d587fc5d1d1f3c94c20753d36d61d988b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page