Skip to main content

A lightweight WebSocket-based communication library

Project description

Lazy Socket

An attempt at creating a websocket based communication system that handles all the threading and async stuff in the background.

Installation

pip install lazy-socket

Usage

Server

The server can be created by subclassing LazyServer and implementing the process_message method. This is an async method that will be called whenever a message is received from a client. To respond to the client, use the send method of the client object passed to the method. A list of clients is available via the clients attribute of the server.

import asyncio
from lazy_socket.server import LazyServer


class Server(LazyServer):

    async def process_message(self, client, message):
        await client.send(f"Received: {message}")

if __name__ == "__main__":
    server = Server(name="TestServer", host="0.0.0.0", port=5000, version="1.0")

    try:
        server.start()
    except KeyboardInterrupt:
        print("Shutting down server...")

Client

The client can be created by instantiating the LazyClient class. The client has a queue attribute that can be used to receive messages from the server. The client must be started using the start method. Messages can be sent to the server using the send method.

A message lazy_client:connected:{uri} is sent to the queue when the client successfully connects to the server.

from lazy_socket.client import LazyClient

client = LazyClient()
client.start()

while True:
    if client.queue.empty():
        continue

    message = client.queue.get()
    if message.startswith("lazy_client:connected:"): 
        client.send("Hello, Lazy Server!")

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lazy_socket-0.0.6.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lazy_socket-0.0.6-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file lazy_socket-0.0.6.tar.gz.

File metadata

  • Download URL: lazy_socket-0.0.6.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for lazy_socket-0.0.6.tar.gz
Algorithm Hash digest
SHA256 42915cc4a6a255a5e5674a0961c4b009fc7b9329c08261269e28a22db166a8ee
MD5 7ffcbf2c73674dcdde3bd1e26cf41cd2
BLAKE2b-256 a385853647bf595de2dd2f6356acfd3dbd804bc9839f10af2c37fa76149f954d

See more details on using hashes here.

File details

Details for the file lazy_socket-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: lazy_socket-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for lazy_socket-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 dc88847d1bba6651c8acc165fc88d033cba176036a89bb0ef4505926106e924a
MD5 68ebee27fe5553c443fb681d79260bda
BLAKE2b-256 6afbb2ceb734b2fb5849a2f52140be11a6072232da246d0c51aef43ed6bfa44e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page