v2kit 0.2__tar.gz → 0.3__tar.gz

{v2kit-0.2 → v2kit-0.3}/AUTHORS.md

@@ -5,7 +5,7 @@
 
 # Other Contributors
 ----------
-- [ChatGPT](https://chat.openai.com/) ++
+- [Gemini](https://gemini.google.com) ++
 
 ++ Graphic designer
 

{v2kit-0.2 → v2kit-0.3}/CHANGELOG.md

@@ -5,6 +5,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [0.3] - 2026-06-16
+### Added
+- Logo
+- `SocksConfig` class
+- `is_socks` function
+### Changed
+- `README.md` updated
+- Test system modified
+- Dependencies structure modified
+- All config models moved to `models` folder
 ## [0.2] - 2026-06-04
 ### Added
 - `VMESSConfig` class
@@ -33,7 +43,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - `encode_subscription` function
 - `decode_subscription` function
 
-[Unreleased]: https://github.com/sepandhaghighi/v2kit/compare/v0.2...dev
+[Unreleased]: https://github.com/sepandhaghighi/v2kit/compare/v0.3...dev
+[0.3]: https://github.com/sepandhaghighi/v2kit/compare/v0.2...v0.3
 [0.2]: https://github.com/sepandhaghighi/v2kit/compare/v0.1...v0.2
 [0.1]: https://github.com/sepandhaghighi/v2kit/compare/bb5a2cb...v0.1
 

{v2kit-0.2 → v2kit-0.3}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: v2kit
-Version: 0.2
+Version: 0.3
 Summary: V2Kit: A Lightweight Toolkit for V2Ray Config Manipulation
 Home-page: https://github.com/sepandhaghighi/v2kit
-Download-URL: https://github.com/sepandhaghighi/v2kit/tarball/v0.2
+Download-URL: https://github.com/sepandhaghighi/v2kit/tarball/v0.3
 Author: Sepand Haghighi
 Author-email: me@sepand.tech
 License: MIT
@@ -44,6 +44,7 @@ Dynamic: summary
 
 
 <div align="center">
+<img src="https://github.com/sepandhaghighi/v2kit/raw/main/otherfiles/logo.png" width="350">
 <h1>V2Kit: A Lightweight Toolkit for V2Ray Config Manipulation</h1>
 <br/>
 <a href="https://www.python.org/"><img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3"></a>
@@ -95,13 +96,13 @@ V2Kit is a lightweight and extensible Python toolkit for working with V2Ray prox
 ## Installation		
 
 ### Source Code
-- Download [Version 0.2](https://github.com/sepandhaghighi/v2kit/archive/v0.2.zip) or [Latest Source](https://github.com/sepandhaghighi/v2kit/archive/dev.zip)
+- Download [Version 0.3](https://github.com/sepandhaghighi/v2kit/archive/v0.3.zip) or [Latest Source](https://github.com/sepandhaghighi/v2kit/archive/dev.zip)
 - `pip install .`				
 
 ### PyPI
 
 - Check [Python Packaging User Guide](https://packaging.python.org/installing/)     
-- `pip install v2kit==0.2`						
+- `pip install v2kit==0.3`						
 
 ## Supported Protocols
 
@@ -113,6 +114,7 @@ V2Kit currently supports the following protocols:
 | VLESS       | ✅         | ✅       | ✅          | ✅           |
 | Trojan      | ✅         | ✅       | ✅          | ✅           |
 | Shadowsocks | ✅         | ✅       | ✅          | ✅           |
+| SOCKS       | ✅         | ✅       | ✅          | ✅           |
 
 
 ## Usage
@@ -208,6 +210,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [0.3] - 2026-06-16
+### Added
+- Logo
+- `SocksConfig` class
+- `is_socks` function
+### Changed
+- `README.md` updated
+- Test system modified
+- Dependencies structure modified
+- All config models moved to `models` folder
 ## [0.2] - 2026-06-04
 ### Added
 - `VMESSConfig` class
@@ -236,7 +248,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - `encode_subscription` function
 - `decode_subscription` function
 
-[Unreleased]: https://github.com/sepandhaghighi/v2kit/compare/v0.2...dev
+[Unreleased]: https://github.com/sepandhaghighi/v2kit/compare/v0.3...dev
+[0.3]: https://github.com/sepandhaghighi/v2kit/compare/v0.2...v0.3
 [0.2]: https://github.com/sepandhaghighi/v2kit/compare/v0.1...v0.2
 [0.1]: https://github.com/sepandhaghighi/v2kit/compare/bb5a2cb...v0.1
 

{v2kit-0.2 → v2kit-0.3}/README.md

@@ -1,4 +1,5 @@
 <div align="center">
+<img src="https://github.com/sepandhaghighi/v2kit/raw/main/otherfiles/logo.png" width="350">
 <h1>V2Kit: A Lightweight Toolkit for V2Ray Config Manipulation</h1>
 <br/>
 <a href="https://www.python.org/"><img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3"></a>
@@ -50,13 +51,13 @@ V2Kit is a lightweight and extensible Python toolkit for working with V2Ray prox
 ## Installation		
 
 ### Source Code
-- Download [Version 0.2](https://github.com/sepandhaghighi/v2kit/archive/v0.2.zip) or [Latest Source](https://github.com/sepandhaghighi/v2kit/archive/dev.zip)
+- Download [Version 0.3](https://github.com/sepandhaghighi/v2kit/archive/v0.3.zip) or [Latest Source](https://github.com/sepandhaghighi/v2kit/archive/dev.zip)
 - `pip install .`				
 
 ### PyPI
 
 - Check [Python Packaging User Guide](https://packaging.python.org/installing/)     
-- `pip install v2kit==0.2`						
+- `pip install v2kit==0.3`						
 
 ## Supported Protocols
 
@@ -68,6 +69,7 @@ V2Kit currently supports the following protocols:
 | VLESS       | ✅         | ✅       | ✅          | ✅           |
 | Trojan      | ✅         | ✅       | ✅          | ✅           |
 | Shadowsocks | ✅         | ✅       | ✅          | ✅           |
+| SOCKS       | ✅         | ✅       | ✅          | ✅           |
 
 
 ## Usage

{v2kit-0.2 → v2kit-0.3}/SECURITY.md

@@ -4,8 +4,8 @@
 
 | Version       | Supported          |
 | ------------- | ------------------ |
-| 0.2           | :white_check_mark: |
-| < 0.2         | :x:                |
+| 0.3           | :white_check_mark: |
+| < 0.3         | :x:                |
 
 ## Reporting a Vulnerability
 

v2kit-0.2/dev-requirements.txt → v2kit-0.3/requirements-dev.txt

@@ -4,3 +4,5 @@ setuptools>=40.8.0
 vulture>=1.0
 bandit>=1.5.1
 pydocstyle>=6.3.0
+build>=1.1.1
+twine>=4.0.2

{v2kit-0.2 → v2kit-0.3}/setup.py

@@ -1,17 +1,6 @@
 # -*- coding: utf-8 -*-
 """Setup module."""
-from typing import List
-try:
-    from setuptools import setup
-except ImportError:
-    from distutils.core import setup
-
-
-def get_requires() -> List[str]:
-    """Read requirements.txt."""
-    requirements = open("requirements.txt", "r").read()
-    return list(filter(lambda x: x != "", requirements.split()))
-
+from setuptools import setup
 
 def read_description() -> str:
     """Read README.md and CHANGELOG.md."""
@@ -32,8 +21,8 @@ def read_description() -> str:
 
 setup(
     name='v2kit',
-    packages=['v2kit'],
-    version='0.2',
+    packages=['v2kit', 'v2kit.models'],
+    version='0.3',
     description='V2Kit: A Lightweight Toolkit for V2Ray Config Manipulation',
     long_description=read_description(),
     long_description_content_type='text/markdown',
@@ -41,11 +30,11 @@ setup(
     author='Sepand Haghighi',
     author_email='me@sepand.tech',
     url='https://github.com/sepandhaghighi/v2kit',
-    download_url='https://github.com/sepandhaghighi/v2kit/tarball/v0.2',
-    keywords="v2ray v2ray-config v2ray-tools vmess vless trojan shadowsocks proxy subscription network",
+    download_url='https://github.com/sepandhaghighi/v2kit/tarball/v0.3',
+    keywords='v2ray v2ray-config v2ray-tools vmess vless trojan shadowsocks proxy subscription network',
     project_urls={
         'Source': 'https://github.com/sepandhaghighi/v2kit'},
-    install_requires=get_requires(),
+    install_requires=[],
     python_requires='>=3.8',
     classifiers=[
         'Development Status :: 3 - Alpha',

{v2kit-0.2 → v2kit-0.3}/tests/test_errors.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 import pytest
-from v2kit import VMESSConfig, VLESSConfig, TrojanConfig, ShadowsocksConfig
+from v2kit import VMESSConfig, VLESSConfig, TrojanConfig, ShadowsocksConfig, SocksConfig
 from v2kit import relabel, encode_subscription, decode_subscription, parse
 from v2kit import V2kitError, V2kitValidationError, V2kitParseError
 from v2kit.validators import _validate_uri
@@ -166,3 +166,37 @@ def test_shadowsocks_empty_encryption():
             address="example.com",
             port=8388,
         )
+
+
+def test_socks_invalid_port():
+    with pytest.raises(V2kitValidationError):
+        SocksConfig(
+            address="example.com",
+            port=70000,
+        )
+
+
+def test_socks_empty_address():
+    with pytest.raises(V2kitValidationError):
+        SocksConfig(
+            address="",
+            port=1080,
+        )
+
+
+def test_socks_invalid_username():
+    with pytest.raises(V2kitValidationError):
+        SocksConfig(
+            address="example.com",
+            port=1080,
+            username="",
+        )
+
+
+def test_socks_invalid_password():
+    with pytest.raises(V2kitValidationError):
+        SocksConfig(
+            address="example.com",
+            port=1080,
+            password="",
+        )

{v2kit-0.2 → v2kit-0.3}/tests/test_functions.py

@@ -1,9 +1,9 @@
 # -*- coding: utf-8 -*-
 
 import json
-from v2kit import is_vmess, is_vless, is_trojan, is_shadowsocks, parse
+from v2kit import is_vmess, is_vless, is_trojan, is_shadowsocks, is_socks, parse
 from v2kit import relabel, encode_subscription, decode_subscription
-from v2kit import VMESSConfig, VLESSConfig, TrojanConfig, ShadowsocksConfig
+from v2kit import VMESSConfig, VLESSConfig, TrojanConfig, ShadowsocksConfig, SocksConfig
 from v2kit.utils import _encode_base64
 
 
@@ -29,19 +29,13 @@ def create_vmess(label="test"):
 
 VMESS_CONFIG = create_vmess()
 
-VLESS_CONFIG = (
-    "vless://1c4b4bca-e3ff-4ca8-a062-6f399ad3cf45@example.com:443"
-    "?security=tls#vless-test"
-)
+VLESS_CONFIG = "vless://1c4b4bca-e3ff-4ca8-a062-6f399ad3cf45@example.com:443?security=tls#vless-test"
 
-TROJAN_CONFIG = (
-    "trojan://password@example.com:443"
-    "?security=tls#trojan-test"
-)
+TROJAN_CONFIG = "trojan://password@example.com:443?security=tls#trojan-test"
 
-SHADOWSOCKS_CONFIG = (
-    "ss://YWVzLTI1Ni1nY206cGFzc3dvcmQ=@example.com:8388#ss-test"
-)
+SHADOWSOCKS_CONFIG = "ss://YWVzLTI1Ni1nY206cGFzc3dvcmQ=@example.com:8388#ss-test"
+
+SOCKS_CONFIG = "socks://user:password@example.com:1080#socks-test"
 
 
 def test_is_vmess():
@@ -80,6 +74,14 @@ def test_is_shadowsocks_invalid():
     assert is_shadowsocks("invalid") is False
 
 
+def test_is_socks():
+    assert is_socks(SOCKS_CONFIG) is True
+
+
+def test_is_socks_invalid():
+    assert is_socks("invalid") is False
+
+
 def test_relabel_vmess():
     result = relabel(VMESS_CONFIG, "new-label")
 
@@ -142,6 +144,7 @@ def test_encode_decode_subscription_roundtrip():
         VLESS_CONFIG,
         TROJAN_CONFIG,
         SHADOWSOCKS_CONFIG,
+        SOCKS_CONFIG,
     ]
 
     encoded = encode_subscription(configs)
@@ -206,3 +209,10 @@ def test_parse_shadowsocks():
         parse(SHADOWSOCKS_CONFIG),
         ShadowsocksConfig,
     )
+
+
+def test_parse_socks():
+    assert isinstance(
+        parse(SOCKS_CONFIG),
+        SocksConfig,
+    )

v2kit-0.3/tests/test_shadowsocks.py

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+from v2kit import parse
+from v2kit import ShadowsocksConfig
+
+
+def test_to_uri_roundtrip():
+    config = ShadowsocksConfig(
+        encryption="aes-256-gcm",
+        password="password",
+        address="example.com",
+        port=8388,
+        label="test",
+    )
+
+    parsed = parse(config.to_uri())
+
+    assert parsed == config

v2kit-0.3/tests/test_socks.py

@@ -0,0 +1,69 @@
+# -*- coding: utf-8 -*-
+from v2kit import parse
+from v2kit import SocksConfig
+
+
+def test_update_methods():
+    config = SocksConfig(
+        address="example.com",
+        port=1080,
+    )
+
+    config.update_username("user")
+    config.update_password("password")
+
+    assert config.username == "user"
+    assert config.password == "password"
+
+
+def test_to_uri_roundtrip():
+    config = SocksConfig(
+        address="example.com",
+        port=1080,
+        username="user",
+        password="password",
+        label="test",
+    )
+
+    parsed = parse(config.to_uri())
+
+    assert parsed == config
+
+
+def test_config_equality():
+    config1 = SocksConfig(
+        address="example.com",
+        port=1080,
+        username="user",
+        password="password",
+    )
+
+    config2 = SocksConfig(
+        address="example.com",
+        port=1080,
+        username="user",
+        password="password",
+    )
+
+    assert config1 == config2
+
+
+def test_to_uri_without_auth():
+    config = SocksConfig(
+        address="example.com",
+        port=1080,
+        label="test",
+    )
+
+    assert config.to_uri() == "socks://example.com:1080#test"
+
+
+def test_to_uri_username_only():
+    config = SocksConfig(
+        address="example.com",
+        port=1080,
+        username="user",
+        label="test",
+    )
+
+    assert config.to_uri() == "socks://user@example.com:1080#test"

v2kit-0.3/tests/test_trojan.py

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+
+from v2kit import parse
+from v2kit import TrojanConfig
+
+
+def test_to_uri_roundtrip():
+    config = TrojanConfig(
+        password="password",
+        address="example.com",
+        port=443,
+        label="test",
+    )
+
+    parsed = parse(config.to_uri())
+
+    assert parsed == config

v2kit-0.3/tests/test_vless.py

@@ -0,0 +1,58 @@
+# -*- coding: utf-8 -*-
+
+from v2kit import parse
+from v2kit import VLESSConfig
+
+
+def test_to_uri_roundtrip():
+    config = VLESSConfig(
+        uuid="1c4b4bca-e3ff-4ca8-a062-6f399ad3cf45",
+        address="example.com",
+        port=443,
+        label="test",
+        extra={"security": "tls"},
+    )
+
+    parsed = parse(config.to_uri())
+
+    assert parsed == config
+
+
+def test_config_equality():
+    config1 = VLESSConfig(
+        uuid="1c4b4bca-e3ff-4ca8-a062-6f399ad3cf45",
+        address="example.com",
+        port=443,
+    )
+
+    config2 = VLESSConfig(
+        uuid="1c4b4bca-e3ff-4ca8-a062-6f399ad3cf45",
+        address="example.com",
+        port=443,
+    )
+
+    assert config1 == config2
+
+
+def test_config_repr():
+    config = VLESSConfig(
+        uuid="1c4b4bca-e3ff-4ca8-a062-6f399ad3cf45",
+        address="example.com",
+        port=443,
+    )
+
+    assert "VLESSConfig" in repr(config)
+
+
+def test_update_extra():
+    config = VLESSConfig(
+        uuid="1c4b4bca-e3ff-4ca8-a062-6f399ad3cf45",
+        address="example.com",
+        port=443,
+    )
+
+    config.update_extra(
+        {"security": "tls"}
+    )
+
+    assert config.extra["security"] == "tls"

v2kit-0.3/tests/test_vmess.py

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+from v2kit import parse
+from v2kit import VMESSConfig
+
+
+def test_to_uri_roundtrip():
+    config = VMESSConfig(
+        uuid="1c4b4bca-e3ff-4ca8-a062-6f399ad3cf45",
+        address="example.com",
+        port=443,
+        label="test",
+    )
+
+    parsed = parse(config.to_uri())
+
+    assert parsed == config
+
+
+def test_update_methods():
+    config = VMESSConfig(
+        uuid="1c4b4bca-e3ff-4ca8-a062-6f399ad3cf45",
+        address="example.com",
+        port=443,
+    )
+
+    config.update_network("ws")
+    config.update_tls("tls")
+    config.update_alter_id(1)
+
+    assert config.network == "ws"
+    assert config.tls == "tls"
+    assert config.alter_id == 1

{v2kit-0.2 → v2kit-0.3}/v2kit/__init__.py

@@ -2,7 +2,7 @@
 """v2kit modules."""
 from .params import V2KIT_VERSION, Protocol
 from .errors import V2kitError, V2kitValidationError, V2kitParseError
-from .functions import is_vmess, is_vless, is_trojan, is_shadowsocks
+from .functions import is_vmess, is_vless, is_trojan, is_shadowsocks, is_socks
 from .functions import relabel
 from .functions import encode_subscription, decode_subscription
 from .parsers import parse
@@ -11,6 +11,7 @@ from .models import (
     VLESSConfig,
     TrojanConfig,
     ShadowsocksConfig,
+    SocksConfig,
 )
 __version__ = V2KIT_VERSION
 
@@ -22,6 +23,7 @@ __all__ = [
     "is_vless",
     "is_trojan",
     "is_shadowsocks",
+    "is_socks",
     "relabel",
     "encode_subscription",
     "decode_subscription",
@@ -30,4 +32,5 @@ __all__ = [
     "VMESSConfig",
     "VLESSConfig",
     "TrojanConfig",
-    "ShadowsocksConfig"]
+    "ShadowsocksConfig",
+    "SocksConfig"]

{v2kit-0.2 → v2kit-0.3}/v2kit/functions.py

@@ -3,7 +3,7 @@
 from typing import Iterable, List, Union
 from .errors import V2kitValidationError
 from .params import Protocol, INVALID_ITEMS_MESSAGE
-from .utils import _get_protocol, _is_protocol
+from .utils import _is_protocol
 from .utils import _encode_base64, _decode_base64
 from .validators import _validate_non_empty_string
 from .parsers import parse
@@ -46,6 +46,15 @@ def is_shadowsocks(uri: str) -> bool:
     return _is_protocol(uri, Protocol.SHADOWSOCKS)
 
 
+def is_socks(uri: str) -> bool:
+    """
+    Check whether URI is SOCKS.
+
+    :param uri: V2Ray URI.
+    """
+    return _is_protocol(uri, Protocol.SOCKS)
+
+
 def relabel(uri: str, label: str) -> str:
     """
     Relabel any supported URI.

v2kit-0.3/v2kit/models/__init__.py

@@ -0,0 +1,9 @@
+"""models module."""
+from .base import BaseConfig
+from .socks import SocksConfig
+from .shadowsocks import ShadowsocksConfig
+from .vless import VLESSConfig
+from .vmess import VMESSConfig
+from .trojan import TrojanConfig
+
+__all__ = ["BaseConfig", "SocksConfig", "ShadowsocksConfig", "VLESSConfig", "VMESSConfig", "TrojanConfig"]