Skip to main content

Pure-Python port of Baileys - WhatsApp Web protocol client (no Node.js).

Project description

WAeys

Python PyPI - Version PyPI - Python Versions PyPI - License GitHub Workflow Status

Pure-Python port of Baileys — a WhatsApp Web protocol client. No Node.js / node_modules dependency: all crypto is pure Python.

Features

  • WhatsApp Web protocol over WebSockets (Noise-encrypted)
  • E2EE (Signal) sessions in pure Python
  • Pairing code & QR login
  • Messages: text, media, contacts, location, react, poll, events, and more
  • Interactive messages (buttons, lists, templates) via raw protobuf
  • Session persistence with a pluggable key store
  • Fully typed generated protobuf classes (no google.protobuf dependency)
  • Message retry manager for undelivered messages

Install

pip install waeys

Requires Python 3.10+. Only runtime dependency: websockets>=12.0.

Documentation

Complete guides (very detailed, in three languages):

Language Guide
English docs/usage.en.md
Español docs/usage.es.md
Português docs/usage.pt.md

Quick usage

import asyncio

from WAeys.Defaults.index import default_connection_config
from WAeys.Utils.auth_utils import init_auth_creds
from WAeys.Utils.browser_utils import Browsers
from WAeys.Socket.socket import make_socket


async def main():
    config = default_connection_config()
    config['auth'] = {'creds': init_auth_creds(), 'keys': make_file_key_store()}
    config['browser'] = Browsers.macOS('Safari')
    config['logger'].level = 'info'

    sock = make_socket(config)
    ev = sock['ev']

    async def on_conn(update):
        if update.get('qr'):
            print('Scan the QR in WhatsApp > Linked Devices')
            print(update['qr'])
        if update.get('connection') == 'open':
            await sock['sendMessage']('51921826291@s.whatsapp.net', {'text': 'Hello from WAeys!'})

    ev.on('connection.update', lambda u: asyncio.ensure_future(on_conn(u)))
    await asyncio.Event().wait()


if __name__ == '__main__':
    asyncio.run(main())

See the full guides above for pairing codes, session persistence, media, interactive messages, events and production tips.

Compatibility

WAeys is pure Python and runs on Linux, macOS, Windows, Android (Termux), Docker, VPS and Raspberry Pi.

Disclaimer

This is an unofficial client for the WhatsApp Web protocol. Using it may violate WhatsApp's Terms of Service and can lead to account bans. Use at your own risk. This project is not affiliated with WhatsApp or Meta.

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

waeys-0.1.2.tar.gz (412.1 kB view details)

Uploaded Source

Built Distribution

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

waeys-0.1.2-py3-none-any.whl (405.5 kB view details)

Uploaded Python 3

File details

Details for the file waeys-0.1.2.tar.gz.

File metadata

  • Download URL: waeys-0.1.2.tar.gz
  • Upload date:
  • Size: 412.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.13

File hashes

Hashes for waeys-0.1.2.tar.gz
Algorithm Hash digest
SHA256 287bcc3b471b972c0ab457613f180bc5b39a0dddeb93b761b4ab75eed7340abb
MD5 c38b23d77950ab0e1adbb4ec0c800908
BLAKE2b-256 a75ab88f46ffa2d13aaef8818e1cb9507ac05b638686f86d46ed69e9fab01921

See more details on using hashes here.

File details

Details for the file waeys-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: waeys-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 405.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.13

File hashes

Hashes for waeys-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3ddf1f064f0d55f71d215403968a440a3b46d230bfe6076648b5232d8600d8ec
MD5 0d9b627ec2366a1cc908765b618eaea4
BLAKE2b-256 fa59f6ae73d990c7a469edb2f7a14fcba2871e6e0e912b2de4b27b621edd3dd9

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