[](https://badge.fury.io/py/psocket)
[](https://travis-ci.org/c-pher/PSocket)
[](https://coveralls.io/github/c-pher/PSocket?branch=master)
# PSocket
The cross-platform simple tool to work with remote server through sockets.
It can establish socket connection to a remote host:port, send commands and receive response.
No need to send byte-string. Use usual strings to send command.
## Installation
For most users, the recommended method to install is via pip:
```cmd
pip install psocket
```
or from source:
```cmd
python setup.py install
```
## Import
```python
from psocket import SocketClient
```
---
## Usage
```python
from psocket import SocketClient
client = SocketClient(host='172.16.0.48', port=3261)
print(client)
```
```python
from psocket import SocketClient
client = SocketClient(host='172.16.0.48', port=3261, initialize=True)
print(client.send_command('<commands>'))
```
---
## Changelog
##### 1.1.4 (29.05.2023)
- debug log extended with timeout error
- global timeout management added
##### 1.1.3 (26.05.2023)
- Reading completion from the socket fixed
- buffer size reduced to 4k
- Logger extended
- Refactoring
##### 1.1.2 (25.05.2023)
- buffer size increased to 8k
- debug log added
##### 1.1.1 (04.08.2022)
- Detect command is completed by \n\n
##### 1.1.0 (23.07.2022)
- log format changed
##### 1.0.9 (4.06.2022)
- response now split lines (instead of .split('\n'))
- logger now is static `SocketClient`
- "greeting" class attr added
- minor changes in logging format
- socket timeout log level changed from debug to warning
##### 1.0.8 (22.04.2022)
- Set blocking after command send with it
##### 1.0.7 (18.04.2022)
- ._socket_response() renamed to ._receive_all() and changed to read huge amount of data from socket
- buffer size changed to 4k (instead of 64k)
- .send_command() extended with "timeout=None" param
##### 1.0.6 (17.04.2022)
- refactored to manage logger state
##### 1.0.5 (6.04.2022)
- logger moved inside class as attr in order to get access to it from outside
- unknown attr access handling added
-
##### 1.0.4 (14.06.2021)
Added host address logging
##### 1.0.3 (12.03.2021)
- Added ability to disable logs
- "timeout connection" added as parameter with None default value
##### 1.0.2 (15.01.2020)
Added "initialize" param to the constructor
##### 1.0.1 (15.01.2020)
- "is_host_available()" renamed to "is_socket_available()" and updated
- used external logger from "plogger" package
##### 1.0.0a4 (15.01.2020)
- added init docstring
- init notation changed:
- host is string
- port is integer
##### 1.0.0a3 (14.01.2020)
- removed timeout from socket connection
- greeting and socket_response now are private methods
##### 1.0.0a2 (13.01.2020)
Reverted "client". Now it is an attribute again to keep session alive
##### 1.0.0a1 (13.01.2020)
- Now connection creates with client property
- New methods added:
- is_host_available()
- get_sock_name()
- get_peer_name()
##### 1.0.0a0 (13.01.2020)
- initial commit
Raw data
{
"_id": null,
"home_page": "https://github.com/c-pher/PSocket.git",
"name": "psocket",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Andrey Komissarov",
"author_email": "a.komisssarov@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/03/29/97df60b7c1a692a0383dae45ee2228efe8fbfa01005f5d3ee677b120e72e/psocket-1.1.4.tar.gz",
"platform": null,
"description": "[](https://badge.fury.io/py/psocket)\n[](https://travis-ci.org/c-pher/PSocket)\n[](https://coveralls.io/github/c-pher/PSocket?branch=master)\n\n\n# PSocket\nThe cross-platform simple tool to work with remote server through sockets. \nIt can establish socket connection to a remote host:port, send commands and receive response.\nNo need to send byte-string. Use usual strings to send command.\n\n## Installation\nFor most users, the recommended method to install is via pip:\n```cmd\npip install psocket\n```\n\nor from source:\n\n```cmd\npython setup.py install\n```\n\n## Import\n```python\nfrom psocket import SocketClient\n```\n---\n## Usage\n```python\nfrom psocket import SocketClient\n\nclient = SocketClient(host='172.16.0.48', port=3261)\nprint(client)\n```\n```python\nfrom psocket import SocketClient\n\nclient = SocketClient(host='172.16.0.48', port=3261, initialize=True)\nprint(client.send_command('<commands>'))\n```\n\n---\n\n## Changelog\n\n##### 1.1.4 (29.05.2023)\n\n- debug log extended with timeout error\n- global timeout management added\n\n##### 1.1.3 (26.05.2023)\n\n- Reading completion from the socket fixed\n- buffer size reduced to 4k\n- Logger extended\n- Refactoring\n\n##### 1.1.2 (25.05.2023)\n\n- buffer size increased to 8k\n- debug log added\n\n##### 1.1.1 (04.08.2022)\n\n- Detect command is completed by \\n\\n\n\n##### 1.1.0 (23.07.2022)\n\n- log format changed\n\n##### 1.0.9 (4.06.2022)\n\n- response now split lines (instead of .split('\\n'))\n- logger now is static `SocketClient`\n- \"greeting\" class attr added\n- minor changes in logging format\n- socket timeout log level changed from debug to warning\n\n##### 1.0.8 (22.04.2022)\n\n- Set blocking after command send with it\n\n##### 1.0.7 (18.04.2022)\n\n- ._socket_response() renamed to ._receive_all() and changed to read huge amount of data from socket\n- buffer size changed to 4k (instead of 64k)\n- .send_command() extended with \"timeout=None\" param\n\n##### 1.0.6 (17.04.2022)\n\n- refactored to manage logger state\n\n##### 1.0.5 (6.04.2022)\n\n- logger moved inside class as attr in order to get access to it from outside\n- unknown attr access handling added\n-\n\n##### 1.0.4 (14.06.2021)\n\nAdded host address logging\n\n##### 1.0.3 (12.03.2021)\n\n- Added ability to disable logs\n- \"timeout connection\" added as parameter with None default value\n\n##### 1.0.2 (15.01.2020)\n\nAdded \"initialize\" param to the constructor\n\n##### 1.0.1 (15.01.2020)\n\n- \"is_host_available()\" renamed to \"is_socket_available()\" and updated\n- used external logger from \"plogger\" package\n\n##### 1.0.0a4 (15.01.2020)\n- added init docstring\n- init notation changed:\n - host is string\n - port is integer\n\n##### 1.0.0a3 (14.01.2020)\n- removed timeout from socket connection\n- greeting and socket_response now are private methods\n\n##### 1.0.0a2 (13.01.2020)\nReverted \"client\". Now it is an attribute again to keep session alive \n\n##### 1.0.0a1 (13.01.2020)\n- Now connection creates with client property\n- New methods added:\n - is_host_available() \n - get_sock_name()\n - get_peer_name()\n\n##### 1.0.0a0 (13.01.2020)\n- initial commit\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "The cross-platform tool to work with remote connection using sockets",
"version": "1.1.4",
"project_urls": {
"Homepage": "https://github.com/c-pher/PSocket.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a0addc00a661291b3a1c1b36caa2e42bc2eb02028c7cb1662a013e002b473de2",
"md5": "8ca2565e4bd6dde97731b0a27c5066b9",
"sha256": "aafd43bb9181f4f9336daabf7c507209f80b5aad5ca5bd02fe0fca97e5b7166b"
},
"downloads": -1,
"filename": "psocket-1.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8ca2565e4bd6dde97731b0a27c5066b9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 5479,
"upload_time": "2023-05-29T16:59:28",
"upload_time_iso_8601": "2023-05-29T16:59:28.155137Z",
"url": "https://files.pythonhosted.org/packages/a0/ad/dc00a661291b3a1c1b36caa2e42bc2eb02028c7cb1662a013e002b473de2/psocket-1.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "032997df60b7c1a692a0383dae45ee2228efe8fbfa01005f5d3ee677b120e72e",
"md5": "bee663360fd366d2e9ac214201504a69",
"sha256": "086013dc1bf6b23378a7b5b4eaa624efc20b3860e757037d02e8b6bdb0bd18e7"
},
"downloads": -1,
"filename": "psocket-1.1.4.tar.gz",
"has_sig": false,
"md5_digest": "bee663360fd366d2e9ac214201504a69",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 5372,
"upload_time": "2023-05-29T16:59:30",
"upload_time_iso_8601": "2023-05-29T16:59:30.411513Z",
"url": "https://files.pythonhosted.org/packages/03/29/97df60b7c1a692a0383dae45ee2228efe8fbfa01005f5d3ee677b120e72e/psocket-1.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-29 16:59:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "c-pher",
"github_project": "PSocket",
"github_not_found": true,
"lcname": "psocket"
}
JSON
