# elephant-socks5-client-py
python client of Elephant(L4) tunnel for SOCKS5 empowered by [py-netty](https://github.com/ruanhao/py-netty).
[Elephant Server](https://github.com/ruanhao/elephant-socks5-tunnel) should be deployed first, which is a L4 tunnel server designed to provide a secure and high-performance tunneling solution for TCP traffic.
## Usage
```
$ elephant -h
Usage: elephant [OPTIONS]
Options:
-p, --port INTEGER Local port to bind [default: 1080]
-s, --server TEXT Elephant tunnel server URL (like: ws[s]://localhost:4443/elephant/ws) [required]
-q, --quiet Quiet mode
-l, --log-record Save log to file (elephant-client.log)
-t, --request-timeout INTEGER Session request timeout (seconds) [default: 3]
--no-color Disable color output
-v, --verbose Verbose mode
-n, --tunnels INTEGER RANGE Number of tunnels to achieve load balance [default: 1; 1<=x<=8]
--proxy-ip TEXT Proxy IP
--proxy-port INTEGER Proxy port [default: -1]
--version Show the version and exit.
-h, --help Show this message and exit.
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ruanhao/elephant-socks5-client-py",
"name": "elephant-socks5",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7, <4",
"maintainer_email": "",
"keywords": "proxy,http,non-blocking,py-netty,socks5",
"author": "Hao Ruan",
"author_email": "ruanhao1116@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ce/5c/2e25f22d099bba5080caa548741e7e51b7b1c9a88c7cce044495cd21bec3/elephant-socks5-0.0.21.tar.gz",
"platform": null,
"description": "# elephant-socks5-client-py\npython client of Elephant(L4) tunnel for SOCKS5 empowered by [py-netty](https://github.com/ruanhao/py-netty).\n\n[Elephant Server](https://github.com/ruanhao/elephant-socks5-tunnel) should be deployed first, which is a L4 tunnel server designed to provide a secure and high-performance tunneling solution for TCP traffic.\n\n## Usage\n\n```\n$ elephant -h\nUsage: elephant [OPTIONS]\n\nOptions:\n -p, --port INTEGER Local port to bind [default: 1080]\n -s, --server TEXT Elephant tunnel server URL (like: ws[s]://localhost:4443/elephant/ws) [required]\n -q, --quiet Quiet mode\n -l, --log-record Save log to file (elephant-client.log)\n -t, --request-timeout INTEGER Session request timeout (seconds) [default: 3]\n --no-color Disable color output\n -v, --verbose Verbose mode\n -n, --tunnels INTEGER RANGE Number of tunnels to achieve load balance [default: 1; 1<=x<=8]\n --proxy-ip TEXT Proxy IP\n --proxy-port INTEGER Proxy port [default: -1]\n --version Show the version and exit.\n -h, --help Show this message and exit.\n```\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Elephant socks5 tunnel client",
"version": "0.0.21",
"project_urls": {
"Homepage": "https://github.com/ruanhao/elephant-socks5-client-py"
},
"split_keywords": [
"proxy",
"http",
"non-blocking",
"py-netty",
"socks5"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7b453668eafeac13a0baf98ee59c8ce74b152755eb3ff31548eeb0259ba97788",
"md5": "b0db17abf707d0fd9a6ec17247004d97",
"sha256": "071571b04fc94cf023da539c173e004402a91c22403224eb4e7a05efbaf7b4fe"
},
"downloads": -1,
"filename": "elephant_socks5-0.0.21-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b0db17abf707d0fd9a6ec17247004d97",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7, <4",
"size": 14772,
"upload_time": "2024-03-16T05:55:52",
"upload_time_iso_8601": "2024-03-16T05:55:52.662707Z",
"url": "https://files.pythonhosted.org/packages/7b/45/3668eafeac13a0baf98ee59c8ce74b152755eb3ff31548eeb0259ba97788/elephant_socks5-0.0.21-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ce5c2e25f22d099bba5080caa548741e7e51b7b1c9a88c7cce044495cd21bec3",
"md5": "729f30dfcda895cf1c46586edc2f52b3",
"sha256": "0e7c2c84273c464f28466a6f147a40ae8aca577aad905cb7f58e608a5e7dadf9"
},
"downloads": -1,
"filename": "elephant-socks5-0.0.21.tar.gz",
"has_sig": false,
"md5_digest": "729f30dfcda895cf1c46586edc2f52b3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7, <4",
"size": 13811,
"upload_time": "2024-03-16T05:55:54",
"upload_time_iso_8601": "2024-03-16T05:55:54.563465Z",
"url": "https://files.pythonhosted.org/packages/ce/5c/2e25f22d099bba5080caa548741e7e51b7b1c9a88c7cce044495cd21bec3/elephant-socks5-0.0.21.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-16 05:55:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ruanhao",
"github_project": "elephant-socks5-client-py",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "elephant-socks5"
}
JSON
