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.3.tar.gz (411.2 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.3-py3-none-any.whl (404.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: waeys-0.1.3.tar.gz
  • Upload date:
  • Size: 411.2 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.3.tar.gz
Algorithm Hash digest
SHA256 87c65dc4fedec3e439bf26993a4b5fc3c25f8096f778156c6e42fdad3b82fb78
MD5 37ba5242a5d828d882423d6f8de515d0
BLAKE2b-256 2962f004618ca1e823f98ca67e9ed0f4f26be72b531916acab4de687dc95ff68

See more details on using hashes here.

File details

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

File metadata

  • Download URL: waeys-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 404.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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 4f6ab81ae3ff7449c5b298e3bd447bf395330810cb53f9db103d5a7f21f0dae8
MD5 4e5da58ed42689d2e6bf1cdbd7df82c8
BLAKE2b-256 7d9e6c5ea27d61191078d94b528ad2411b3d079a756dc6c6d0e202f7f9fbda9a

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