Skip to main content

Python async client for EdgyMeow WebSocket API

Project description

EdgyMeow - Python Client

Async Python client for the EdgyMeow WebSocket API.

Installation

pip install edgymeow

Requires the EdgyMeow server running separately:

npm install -g edgymeow
npx edgymeow start

Usage

import asyncio
from edgymeow import WhatsAppRPCClient

async def main():
    client = WhatsAppRPCClient("ws://localhost:9400/ws/rpc")
    await client.connect()

    # Check status
    status = await client.status()
    print(status)

    # Send a text message
    await client.send(phone="1234567890", type="text", message="Hello!")

    # Send an image
    await client.send(
        phone="1234567890",
        type="image",
        media_data={
            "data": "<base64>",
            "mime_type": "image/jpeg",
            "caption": "Check this out!"
        }
    )

    # List groups
    groups = await client.groups()

    # Get chat history
    history = await client.chat_history(phone="1234567890", limit=50)

    # List subscribed channels
    channels = await client.newsletters()

    # Get channel stats
    stats = await client.newsletter_stats(jid="123456789@newsletter", count=20)

    await client.close()

asyncio.run(main())

Events

async def main():
    client = WhatsAppRPCClient("ws://localhost:9400/ws/rpc")

    def on_event(event):
        if event["method"] == "event.message_received":
            print(f"New message: {event['params']['text']}")

    client.event_callback = on_event
    await client.connect()

    # Keep running to receive events
    await asyncio.sleep(3600)
    await client.close()

API Methods

Method Description
status() Get connection status
start() / stop() / restart() Control WhatsApp service
qr() Get QR code for pairing
send(**kwargs) Send message (text, image, video, audio, document, location, contact)
media(message_id) Download media from message
groups() List all groups
group_info(group_id) Get group details
contacts(query) List contacts
contact_check(phones) Check WhatsApp registration
chat_history(**kwargs) Get message history
typing(jid, state) Send typing indicator
presence(status) Set online/offline
mark_read(message_ids, chat_jid) Mark messages as read
rate_limit_get() / rate_limit_set(**config) Rate limiting config
newsletters(refresh) List subscribed channels
newsletter_info(jid, invite, refresh) Get channel details
newsletter_create(name, description, picture) Create a channel
newsletter_follow(jid) Subscribe to a channel
newsletter_unfollow(jid) Unsubscribe from a channel
newsletter_mute(jid, mute) Mute/unmute a channel
newsletter_messages(jid, count, before) Get channel messages
newsletter_send(group_id, type, message, media_data) Send to channel (admin only)
newsletter_mark_viewed(jid, server_ids) Mark messages as viewed
newsletter_react(jid, server_id, reaction) React to a channel message
newsletter_live_updates(jid) Subscribe to live updates
newsletter_stats(jid, invite, count) Get channel statistics

License

MIT

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

edgymeow-0.0.17.tar.gz (9.1 kB view details)

Uploaded Source

Built Distribution

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

edgymeow-0.0.17-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file edgymeow-0.0.17.tar.gz.

File metadata

  • Download URL: edgymeow-0.0.17.tar.gz
  • Upload date:
  • Size: 9.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for edgymeow-0.0.17.tar.gz
Algorithm Hash digest
SHA256 bfc199ac5033146b297b3ac8c94699e0733493ab1f90a2476fc505549497a71b
MD5 feab3d938b737d07525e53a7e60bf2fd
BLAKE2b-256 8f1fbfd4228351b2a8034a073bd4a29bc511c14d018f3947c1bdbf961b82764b

See more details on using hashes here.

File details

Details for the file edgymeow-0.0.17-py3-none-any.whl.

File metadata

  • Download URL: edgymeow-0.0.17-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for edgymeow-0.0.17-py3-none-any.whl
Algorithm Hash digest
SHA256 3cd3258ab63fa2f21604494ec2dac99924f8618fc0f7817399c1b52e0e5ee873
MD5 a3b7ba21fa243d86c084826ae2129f14
BLAKE2b-256 d2aa04b9eb317dd471a160304070d435ae1078dbf5cb5130c36c5dc14992ff2a

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