# EasyNetwork
The easiest way to use sockets in Python!
[](https://pypi.org/project/easynetwork/)
[](https://github.com/francis-clairicia/EasyNetwork/blob/main/LICENSE)
[](https://github.com/francis-clairicia/EasyNetwork/actions/workflows/test.yml)
[](https://easynetwork.readthedocs.io/en/latest/?badge=latest)
[](https://codecov.io/gh/francis-clairicia/EasyNetwork)
[](https://www.codefactor.io/repository/github/francis-clairicia/easynetwork)
[](https://github.com/pre-commit/pre-commit)
[](https://results.pre-commit.ci/latest/github/francis-clairicia/EasyNetwork/main)
[](http://mypy-lang.org/)
[](https://github.com/psf/black)
[](https://pycqa.github.io/isort/)
[](https://github.com/PyCQA/bandit)
[](https://github.com/pypa/hatch)
[](https://pdm.fming.dev)
## Installation
### From PyPI repository
```sh
pip install --user easynetwork
```
### From source
```sh
git clone https://github.com/francis-clairicia/EasyNetwork.git
cd EasyNetwork
pip install --user .
```
## Overview
EasyNetwork completely encapsulates the socket handling, providing you with a higher level interface
that allows an application/software to completely handle the logic part with Python objects,
without worrying about how to process, send or receive data over the network.
The communication protocol can be whatever you want, be it JSON, Pickle, ASCII, structure, base64 encoded,
compressed, or any other format that is not part of the standard library.
You choose the data format and the library takes care of the rest.
This project is especially useful for simple **message** exchange between clients and servers.
Works with TCP and UDP.
Interested ? Here is the documentation : https://easynetwork.readthedocs.io/
## Usage
### TCP Echo server with JSON data
```py
import asyncio
import logging
from collections.abc import AsyncGenerator
from typing import Any, TypeAlias
from easynetwork.protocol import StreamProtocol
from easynetwork.serializers import JSONSerializer
from easynetwork.servers import AsyncTCPNetworkServer
from easynetwork.servers.handlers import AsyncStreamClient, AsyncStreamRequestHandler
# These TypeAliases are there to help you understand
# where requests and responses are used in the code
RequestType: TypeAlias = Any
ResponseType: TypeAlias = Any
class JSONProtocol(StreamProtocol[ResponseType, RequestType]):
def __init__(self) -> None:
super().__init__(JSONSerializer())
class EchoRequestHandler(AsyncStreamRequestHandler[RequestType, ResponseType]):
def __init__(self) -> None:
self.logger: logging.Logger = logging.getLogger(self.__class__.__name__)
async def handle(
self,
client: AsyncStreamClient[ResponseType],
) -> AsyncGenerator[None, RequestType]:
# A JSON request has been sent by this client
data: Any = yield
self.logger.info(f"{client!r} sent {data!r}")
# As a good echo handler, the request is sent back to the client
await client.send_packet(data)
# Leaving the generator will NOT close the connection,
# a new generator will be created afterwards.
# You may manually close the connection if you want to:
# await client.aclose()
async def main() -> None:
host = None # Bind on all interfaces
port = 9000
protocol = JSONProtocol()
handler = EchoRequestHandler()
logging.basicConfig(
level=logging.INFO,
format="[ %(levelname)s ] [ %(name)s ] %(message)s",
)
async with AsyncTCPNetworkServer(host, port, protocol, handler) as server:
await server.serve_forever()
if __name__ == "__main__":
try:
asyncio.run(main())
except* KeyboardInterrupt:
pass
```
### TCP Echo client with JSON data
```py
from typing import Any, TypeAlias
from easynetwork.clients import TCPNetworkClient
from easynetwork.protocol import StreamProtocol
from easynetwork.serializers import JSONSerializer
RequestType: TypeAlias = Any
ResponseType: TypeAlias = Any
class JSONProtocol(StreamProtocol[RequestType, ResponseType]):
def __init__(self) -> None:
super().__init__(JSONSerializer())
def main() -> None:
with TCPNetworkClient(("localhost", 9000), JSONProtocol()) as client:
client.send_packet({"data": {"my_body": ["as json"]}})
response = client.recv_packet() # response should be the sent dictionary
print(response) # prints {'data': {'my_body': ['as json']}}
if __name__ == "__main__":
main()
```
#### Asynchronous version ( with `async def` )
```py
import asyncio
from easynetwork.clients import AsyncTCPNetworkClient
...
async def main() -> None:
async with AsyncTCPNetworkClient(("localhost", 9000), JSONProtocol()) as client:
await client.send_packet({"data": {"my_body": ["as json"]}})
response = await client.recv_packet()
print(response) # prints {'data': {'my_body': ['as json']}}
if __name__ == "__main__":
asyncio.run(main())
```
</details>
## License
This project is licensed under the terms of the [Apache Software License 2.0](https://github.com/francis-clairicia/EasyNetwork/blob/main/LICENSE).
### AnyIO's typed attributes
AnyIO's typed attributes is incorporated in `easynetwork.lowlevel.typed_attr` from [anyio 4.2](https://github.com/agronholm/anyio/tree/4.2.0), which is distributed under the [MIT license](https://github.com/agronholm/anyio/blob/4.2.0/LICENSE).
Raw data
{
"_id": null,
"home_page": null,
"name": "easynetwork",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "async, asynchronous, client, communication, networking, serialization, server, socket",
"author": null,
"author_email": "FrankySnow9 <clairicia.rcj.francis@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/45/fd/bcad812735587a8325612db417fd114127643e75556f375ec44272ae4125/easynetwork-1.0.0.tar.gz",
"platform": null,
"description": "# EasyNetwork\n\nThe easiest way to use sockets in Python!\n\n[](https://pypi.org/project/easynetwork/)\n[](https://github.com/francis-clairicia/EasyNetwork/blob/main/LICENSE)\n\n\n[](https://github.com/francis-clairicia/EasyNetwork/actions/workflows/test.yml)\n[](https://easynetwork.readthedocs.io/en/latest/?badge=latest)\n[](https://codecov.io/gh/francis-clairicia/EasyNetwork)\n[](https://www.codefactor.io/repository/github/francis-clairicia/easynetwork)\n\n[](https://github.com/pre-commit/pre-commit)\n[](https://results.pre-commit.ci/latest/github/francis-clairicia/EasyNetwork/main)\n\n[](http://mypy-lang.org/)\n[](https://github.com/psf/black)\n[](https://pycqa.github.io/isort/)\n[](https://github.com/PyCQA/bandit)\n\n[](https://github.com/pypa/hatch)\n[](https://pdm.fming.dev)\n\n## Installation\n### From PyPI repository\n```sh\npip install --user easynetwork\n```\n\n### From source\n```sh\ngit clone https://github.com/francis-clairicia/EasyNetwork.git\ncd EasyNetwork\npip install --user .\n```\n\n## Overview\nEasyNetwork completely encapsulates the socket handling, providing you with a higher level interface\nthat allows an application/software to completely handle the logic part with Python objects,\nwithout worrying about how to process, send or receive data over the network.\n\nThe communication protocol can be whatever you want, be it JSON, Pickle, ASCII, structure, base64 encoded,\ncompressed, or any other format that is not part of the standard library.\nYou choose the data format and the library takes care of the rest.\n\nThis project is especially useful for simple **message** exchange between clients and servers.\n\nWorks with TCP and UDP.\n\nInterested ? Here is the documentation : https://easynetwork.readthedocs.io/\n\n## Usage\n### TCP Echo server with JSON data\n```py\nimport asyncio\nimport logging\nfrom collections.abc import AsyncGenerator\nfrom typing import Any, TypeAlias\n\nfrom easynetwork.protocol import StreamProtocol\nfrom easynetwork.serializers import JSONSerializer\nfrom easynetwork.servers import AsyncTCPNetworkServer\nfrom easynetwork.servers.handlers import AsyncStreamClient, AsyncStreamRequestHandler\n\n# These TypeAliases are there to help you understand\n# where requests and responses are used in the code\nRequestType: TypeAlias = Any\nResponseType: TypeAlias = Any\n\n\nclass JSONProtocol(StreamProtocol[ResponseType, RequestType]):\n def __init__(self) -> None:\n super().__init__(JSONSerializer())\n\n\nclass EchoRequestHandler(AsyncStreamRequestHandler[RequestType, ResponseType]):\n def __init__(self) -> None:\n self.logger: logging.Logger = logging.getLogger(self.__class__.__name__)\n\n async def handle(\n self,\n client: AsyncStreamClient[ResponseType],\n ) -> AsyncGenerator[None, RequestType]:\n # A JSON request has been sent by this client\n data: Any = yield\n\n self.logger.info(f\"{client!r} sent {data!r}\")\n\n # As a good echo handler, the request is sent back to the client\n await client.send_packet(data)\n\n # Leaving the generator will NOT close the connection,\n # a new generator will be created afterwards.\n # You may manually close the connection if you want to:\n # await client.aclose()\n\n\nasync def main() -> None:\n host = None # Bind on all interfaces\n port = 9000\n protocol = JSONProtocol()\n handler = EchoRequestHandler()\n\n logging.basicConfig(\n level=logging.INFO,\n format=\"[ %(levelname)s ] [ %(name)s ] %(message)s\",\n )\n\n async with AsyncTCPNetworkServer(host, port, protocol, handler) as server:\n await server.serve_forever()\n\n\nif __name__ == \"__main__\":\n try:\n asyncio.run(main())\n except* KeyboardInterrupt:\n pass\n```\n\n### TCP Echo client with JSON data\n```py\nfrom typing import Any, TypeAlias\n\nfrom easynetwork.clients import TCPNetworkClient\nfrom easynetwork.protocol import StreamProtocol\nfrom easynetwork.serializers import JSONSerializer\n\nRequestType: TypeAlias = Any\nResponseType: TypeAlias = Any\n\n\nclass JSONProtocol(StreamProtocol[RequestType, ResponseType]):\n def __init__(self) -> None:\n super().__init__(JSONSerializer())\n\n\ndef main() -> None:\n with TCPNetworkClient((\"localhost\", 9000), JSONProtocol()) as client:\n client.send_packet({\"data\": {\"my_body\": [\"as json\"]}})\n response = client.recv_packet() # response should be the sent dictionary\n print(response) # prints {'data': {'my_body': ['as json']}}\n\n\nif __name__ == \"__main__\":\n main()\n```\n\n#### Asynchronous version ( with `async def` )\n\n```py\nimport asyncio\n\nfrom easynetwork.clients import AsyncTCPNetworkClient\n\n...\n\nasync def main() -> None:\n async with AsyncTCPNetworkClient((\"localhost\", 9000), JSONProtocol()) as client:\n await client.send_packet({\"data\": {\"my_body\": [\"as json\"]}})\n response = await client.recv_packet()\n print(response) # prints {'data': {'my_body': ['as json']}}\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n```\n\n</details>\n\n## License\nThis project is licensed under the terms of the [Apache Software License 2.0](https://github.com/francis-clairicia/EasyNetwork/blob/main/LICENSE).\n\n### AnyIO's typed attributes\n\nAnyIO's typed attributes is incorporated in `easynetwork.lowlevel.typed_attr` from [anyio 4.2](https://github.com/agronholm/anyio/tree/4.2.0), which is distributed under the [MIT license](https://github.com/agronholm/anyio/blob/4.2.0/LICENSE).\n",
"bugtrack_url": null,
"license": null,
"summary": "The easiest way to use sockets in Python",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://easynetwork.readthedocs.io/",
"Issue Tracker": "https://github.com/francis-clairicia/EasyNetwork/issues",
"Release Notes": "https://github.com/francis-clairicia/EasyNetwork/releases",
"Source Code": "https://github.com/francis-clairicia/EasyNetwork"
},
"split_keywords": [
"async",
" asynchronous",
" client",
" communication",
" networking",
" serialization",
" server",
" socket"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9d1f1dd4ebf516b9de6e748878eee7040e56859dd4d2316cbcf1be129997dcc2",
"md5": "7a5eb984c987c0fbdc3e3491c24ec6d3",
"sha256": "2922bfcfaf3e276256e5a260bcdab9e5884893f9fe8619d9efda675ae24099cf"
},
"downloads": -1,
"filename": "easynetwork-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7a5eb984c987c0fbdc3e3491c24ec6d3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 228462,
"upload_time": "2024-09-07T18:22:29",
"upload_time_iso_8601": "2024-09-07T18:22:29.213501Z",
"url": "https://files.pythonhosted.org/packages/9d/1f/1dd4ebf516b9de6e748878eee7040e56859dd4d2316cbcf1be129997dcc2/easynetwork-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "45fdbcad812735587a8325612db417fd114127643e75556f375ec44272ae4125",
"md5": "aec83a6a43bbec28002177f1d2ecbf4e",
"sha256": "3351400379cf5062422dc8849958a452427803d5022bb958a74b106eb7e0a4e5"
},
"downloads": -1,
"filename": "easynetwork-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "aec83a6a43bbec28002177f1d2ecbf4e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 427472,
"upload_time": "2024-09-07T18:22:30",
"upload_time_iso_8601": "2024-09-07T18:22:30.662685Z",
"url": "https://files.pythonhosted.org/packages/45/fd/bcad812735587a8325612db417fd114127643e75556f375ec44272ae4125/easynetwork-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-07 18:22:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "francis-clairicia",
"github_project": "EasyNetwork",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "easynetwork"
}
JSON
