https://github.com/binarskugga/webmesh
Connects microservices through a mesh of websockets
https://github.com/binarskugga/webmesh
mesh mesh-network microservice msgpack parallelism python python3 websocket websocket-library websocket-server websockets zlib
Last synced: 9 months ago
JSON representation
Connects microservices through a mesh of websockets
- Host: GitHub
- URL: https://github.com/binarskugga/webmesh
- Owner: BinarSkugga
- License: apache-2.0
- Created: 2021-07-22T21:47:37.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-01-29T11:57:41.000Z (about 4 years ago)
- Last Synced: 2025-04-12T05:52:15.794Z (11 months ago)
- Topics: mesh, mesh-network, microservice, msgpack, parallelism, python, python3, websocket, websocket-library, websocket-server, websockets, zlib
- Language: Python
- Homepage:
- Size: 84 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WebMesh
WebMesh is a WebSocket based communication library for microservices. It uses a WebSocket server based on [wsproto](https://github.com/python-hyper/wsproto) that distributes clients on a thread pool to achieve high parallelism and performance. It aims at providing the building blocks to inter-connect multiple services at the application level seamlessly. (corporate lorem ipsum ends here).
## Design
[TODO]
## Todo before first release
- [ ] Add SSL Support
- [ ] Improve Failure Resilience (retrying connections etc..)
- [ ] Path arguments and resolution for consumers
- [ ] Implement a Subscription System
- [ ] Node discovery and status reporting
- [ ] Testaments & Last Will maybe ?
- [ ] Implement a class that regroups a server and multiple clients to each peers (WebMesh(server, *peers) ?)
## Tests & Lint
Install nox: `pip install nox`
Execute all the session at the root of the project: `nox`
## Install
Simply execute: `pip install webmesh`
## WebMesh Server
WebMesh's server works like a standard HTTP server. It uses a declarative syntax with decorators defining callbacks on routes. Here's the basic example for a locally accessible echo server:
```python
from typing import Any
from webmesh.websocket.abstract_websocket_connection import AbstractWebSocketConnection
from webmesh.webmesh_server import WebMeshServer
server = WebMeshServer()
@server.on('/')
def echo(payload: Any, path: str, client: AbstractWebSocketConnection):
return payload
server.listen()
server.await_started()
# Server is ready and running in its own thread
server.close()
```
This is all good and pretty but by default, WebMesh uses [msgpack](https://github.com/msgpack/msgpack-python) and zlib to communicate which makes it hard to manually use. You can change the serialization layer by providing an implementation of the `AbstractMessageSerializer` class. WebMesh provides a simple JSON serializer that you can pass into your server's constructor:
```python
from webmesh.webmesh_server import WebMeshServer
from webmesh.message_serializers import StandardJsonSerializer
server = WebMeshServer(serializer_type=StandardJsonSerializer)
```
*Note: We are using the class and not an instance. This is because the websocket backend uses processes for parallelism. This limits us as to what we can use because it requires to be pickled. By passing the class, we can instantiate the serializer inside the process and have more flexibility.*