# socket_request
socket_request is build and parses HTTP requests with unix domain sockets.
### Installing socket_request
socket_request is available on PyPI:
```
pip3 install socket-request
```
Officially supports Python 3.7+.
### Examples:
```python
import socket_request
docker = socket_request.DockerSock(unix_socket="/var/run/docker.sock")
docker.get_docker_images()
```
```python
import socket_request
control_chain = socket_request.ControlChain(unix_socket="./cli.sock")
control_chain.stop()
control_chain.start()
```
## CLI:
$ control_chain --help
```angular2html
╋╋╋╋╋╋╋╋╋┏┓╋╋╋╋╋┏┓╋╋╋╋┏┓
╋╋╋╋╋╋╋╋┏┛┗┓╋╋╋╋┃┃╋╋╋╋┃┃
┏━━┳━━┳━╋┓┏╋━┳━━┫┃╋┏━━┫┗━┳━━┳┳━┓
┃┏━┫┏┓┃┏┓┫┃┃┏┫┏┓┃┃╋┃┏━┫┏┓┃┏┓┣┫┏┓┓
┃┗━┫┗┛┃┃┃┃┗┫┃┃┗┛┃┗┓┃┗━┫┃┃┃┏┓┃┃┃┃┃
┗━━┻━━┻┛┗┻━┻┛┗━━┻━┛┗━━┻┛┗┻┛┗┻┻┛┗┛
version : 1.0.11
base_dir: /app/icon2-node
usage: control_chain [-h] [-s unixsocket] [-d] [-t timeout] [-w wait_state]
[-r retry] [-ws] [-ap auto_prepare] [-p payload_file]
[-f] [-i] [--seedAddress SEEDADDRESS] [-b BASE_DIR]
[-pd payload dict]
{start,stop,reset,leave,view_chain,view_system_config,join,backup,backup_list,restore,chain_config,system_config,ls,prune}
Command Line Interface for control_chain
positional arguments:
{start,stop,reset,leave,view_chain,view_system_config,join,backup,backup_list,restore,chain_config,system_config,ls,prune}
optional arguments:
-h, --help show this help message and exit
-s unixsocket, --unixsocket unixsocket
unix domain socket path (default:
/app/icon2-node/data/cli.socket)
-d, --debug debug mode. (default: False)
-t timeout, --timeout timeout
timeout (default: 60)
-w wait_state, --wait-state wait_state
wait_state (default: True)
-r retry, --retry retry
wait_state (default: True)
-ws, --wait-socket wait for unix domain socket
-ap auto_prepare, --auto_prepare auto_prepare
auto_prepare (default: True)
-p payload_file, --payload payload_file
payload file
-f, --forever retry forever
-i, --inspect inspect for view chain
--seedAddress SEEDADDRESS
seed list string
-b BASE_DIR, --base-dir BASE_DIR
base dir for goloop
-pd payload dict, --payload-dict payload dict
payload dict
-bh BLOCKHEIGHT, --blockheight BLOCKHEIGHT
BlockHeight for pruning
-rn RESTORE_NAME, --restore-name RESTORE_NAME
Restore filename for restore
```
## ConnectSock
- ConnectSock class
- request(self, method="GET", url=None, headers={}, payload={}, files={}, return_dict=False) method
## ControlChain
Parent class is ConnectSock class
- ControlChain class
- start() method
- stop() method
- reset() method
- leave() method
- backup() method
- backup_list() method
- restore(name="name") method
- join(seed_list=["127.0.0.1:7100"], role=3) method
- view_chain(detail=False, inspect=False) method
- chain_config(payload={"key": "autoStart", "value": "true"}) method
- view_system_config() method
- system_config(payload={"key": "rpcIncludeDebug", "value": "true"}) method
## DockerSock
Parent class is ConnectSock class
- DockerSock class
Raw data
{
"_id": null,
"home_page": "https://github.com/jinwoo-j/socket_request",
"name": "socket-request",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Jinwoo Jeong",
"author_email": "jinwoo@parametacorp.com",
"download_url": null,
"platform": null,
"description": "# socket_request\n\nsocket_request is build and parses HTTP requests with unix domain sockets.\n\n### Installing socket_request\n\nsocket_request is available on PyPI:\n\n```\npip3 install socket-request\n\n```\nOfficially supports Python 3.7+.\n\n\n\n### Examples:\n\n```python\nimport socket_request\n\ndocker = socket_request.DockerSock(unix_socket=\"/var/run/docker.sock\")\ndocker.get_docker_images()\n\n```\n\n\n```python\nimport socket_request\n\ncontrol_chain = socket_request.ControlChain(unix_socket=\"./cli.sock\")\ncontrol_chain.stop()\ncontrol_chain.start()\n\n```\n\n## CLI:\n$ control_chain --help\n```angular2html\n\n \u254b\u254b\u254b\u254b\u254b\u254b\u254b\u254b\u254b\u250f\u2513\u254b\u254b\u254b\u254b\u254b\u250f\u2513\u254b\u254b\u254b\u254b\u250f\u2513\n \u254b\u254b\u254b\u254b\u254b\u254b\u254b\u254b\u250f\u251b\u2517\u2513\u254b\u254b\u254b\u254b\u2503\u2503\u254b\u254b\u254b\u254b\u2503\u2503\n \u250f\u2501\u2501\u2533\u2501\u2501\u2533\u2501\u254b\u2513\u250f\u254b\u2501\u2533\u2501\u2501\u252b\u2503\u254b\u250f\u2501\u2501\u252b\u2517\u2501\u2533\u2501\u2501\u2533\u2533\u2501\u2513\n \u2503\u250f\u2501\u252b\u250f\u2513\u2503\u250f\u2513\u252b\u2503\u2503\u250f\u252b\u250f\u2513\u2503\u2503\u254b\u2503\u250f\u2501\u252b\u250f\u2513\u2503\u250f\u2513\u2523\u252b\u250f\u2513\u2513\n \u2503\u2517\u2501\u252b\u2517\u251b\u2503\u2503\u2503\u2503\u2517\u252b\u2503\u2503\u2517\u251b\u2503\u2517\u2513\u2503\u2517\u2501\u252b\u2503\u2503\u2503\u250f\u2513\u2503\u2503\u2503\u2503\u2503\n \u2517\u2501\u2501\u253b\u2501\u2501\u253b\u251b\u2517\u253b\u2501\u253b\u251b\u2517\u2501\u2501\u253b\u2501\u251b\u2517\u2501\u2501\u253b\u251b\u2517\u253b\u251b\u2517\u253b\u253b\u251b\u2517\u251b\n\n\t version : 1.0.11\n\t base_dir: /app/icon2-node\n\n\nusage: control_chain [-h] [-s unixsocket] [-d] [-t timeout] [-w wait_state]\n [-r retry] [-ws] [-ap auto_prepare] [-p payload_file]\n [-f] [-i] [--seedAddress SEEDADDRESS] [-b BASE_DIR]\n [-pd payload dict]\n {start,stop,reset,leave,view_chain,view_system_config,join,backup,backup_list,restore,chain_config,system_config,ls,prune}\n\nCommand Line Interface for control_chain\n\npositional arguments:\n {start,stop,reset,leave,view_chain,view_system_config,join,backup,backup_list,restore,chain_config,system_config,ls,prune}\n\noptional arguments:\n -h, --help show this help message and exit\n -s unixsocket, --unixsocket unixsocket\n unix domain socket path (default:\n /app/icon2-node/data/cli.socket)\n -d, --debug debug mode. (default: False)\n -t timeout, --timeout timeout\n timeout (default: 60)\n -w wait_state, --wait-state wait_state\n wait_state (default: True)\n -r retry, --retry retry\n wait_state (default: True)\n -ws, --wait-socket wait for unix domain socket\n -ap auto_prepare, --auto_prepare auto_prepare\n auto_prepare (default: True)\n -p payload_file, --payload payload_file\n payload file\n -f, --forever retry forever\n -i, --inspect inspect for view chain\n --seedAddress SEEDADDRESS\n seed list string\n -b BASE_DIR, --base-dir BASE_DIR\n base dir for goloop\n -pd payload dict, --payload-dict payload dict\n payload dict\n -bh BLOCKHEIGHT, --blockheight BLOCKHEIGHT\n BlockHeight for pruning\n -rn RESTORE_NAME, --restore-name RESTORE_NAME\n Restore filename for restore \n```\n\n\n## ConnectSock\n- ConnectSock class\n- request(self, method=\"GET\", url=None, headers={}, payload={}, files={}, return_dict=False) method\n\n## ControlChain\nParent class is ConnectSock class\n- ControlChain class\n- start() method\n- stop() method\n- reset() method\n- leave() method\n- backup() method\n- backup_list() method\n- restore(name=\"name\") method\n- join(seed_list=[\"127.0.0.1:7100\"], role=3) method\n- view_chain(detail=False, inspect=False) method\n- chain_config(payload={\"key\": \"autoStart\", \"value\": \"true\"}) method\n- view_system_config() method\n- system_config(payload={\"key\": \"rpcIncludeDebug\", \"value\": \"true\"}) method\n\n\n## DockerSock\nParent class is ConnectSock class\n- DockerSock class\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "socket_request is building and parsing HTTP requests with UNIX domain sockets.",
"version": "1.1.25",
"project_urls": {
"Homepage": "https://github.com/jinwoo-j/socket_request"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dd1560f2b5aadbdcf6d8f1055f3008a7486c507a50ade7da2aded49b75c045a8",
"md5": "179fe8524bee8a7d6ed65666ab132da9",
"sha256": "59266f047bb894b4675b018520bfef03f2116ceec036064cf731f2dbaa90ef55"
},
"downloads": -1,
"filename": "socket_request-1.1.25-py3-none-any.whl",
"has_sig": false,
"md5_digest": "179fe8524bee8a7d6ed65666ab132da9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 28896,
"upload_time": "2024-09-10T08:42:28",
"upload_time_iso_8601": "2024-09-10T08:42:28.787260Z",
"url": "https://files.pythonhosted.org/packages/dd/15/60f2b5aadbdcf6d8f1055f3008a7486c507a50ade7da2aded49b75c045a8/socket_request-1.1.25-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-10 08:42:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jinwoo-j",
"github_project": "socket_request",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "socket-request"
}
JSON
