Skip to main content

Async Python implementation of the WhatsApp Web protocol inspired by Baileys.

Project description

Baileys Python

Baileys-python is an async Python package for WhatsApp Web protocol surfaces, inspired by Node Baileys.

This project is an unofficial Python implementation inspired by WhiskeySockets/Baileys. It is not affiliated with, endorsed by, sponsored by, or maintained by WhiskeySockets/Baileys, WhatsApp, Meta, or any of their subsidiaries or affiliates. WhatsApp and related names, marks, emblems, and images are trademarks of their respective owners.

This is an alpha release. Start with a dedicated test account and review the feature status before using it in a production service.

Install

python -m pip install baileys-python

Documentation

Install For Development

python -m pip install -e ".[dev]"

Build the documentation site locally:

python -m pip install -e ".[docs]"
python -m mkdocs serve

Run Tests

python -m pytest -q

Run Release Gates

python scripts/release_gate.py

License

This package is released under the MIT License. See LICENSE and NOTICE for license text, attribution, and affiliation notices.

Minimal Saved-Auth Login

import asyncio
from pathlib import Path
from baileys import WhatsAppWebClient

async def main():
    async with WhatsAppWebClient(Path("auth/live_pair_creds.json")) as client:
        success = await client.wait_for_success(timeout=60)
        print(success.attrs)

asyncio.run(main())

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

baileys_python-0.1.0a1.tar.gz (317.5 kB view details)

Uploaded Source

Built Distribution

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

baileys_python-0.1.0a1-py3-none-any.whl (285.4 kB view details)

Uploaded Python 3

File details

Details for the file baileys_python-0.1.0a1.tar.gz.

File metadata

  • Download URL: baileys_python-0.1.0a1.tar.gz
  • Upload date:
  • Size: 317.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for baileys_python-0.1.0a1.tar.gz
Algorithm Hash digest
SHA256 d2ac5c3b6ffb5ed7d91872d82b8fa0ec3fad4ac3ede355a8be053a76c38cff12
MD5 79fb0b45ee24cc43b24240c3a205be7a
BLAKE2b-256 393533a2787181a1bd75bc03e60a2830bc031f4bfee3687d429258be357a10af

See more details on using hashes here.

File details

Details for the file baileys_python-0.1.0a1-py3-none-any.whl.

File metadata

File hashes

Hashes for baileys_python-0.1.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 757dcaaa9aeb3eee1022971d4c2c6b03d0cc83f9eeeb359f25ac427ef7d3820e
MD5 8ce69eede3ca709c8e19b658fad742c8
BLAKE2b-256 42be4810b8126a22cb3fa487c9f914465600bf0a43768d26ea8a414428875510

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