Skip to main content

Python wrapper for the WhatsApp Cloud API

Project description

PyWa Logo

PyWa • Python wrapper for the WhatsApp Cloud API

PyPi Downloads PyPI Version Tests Docs License CodeFactor Telegram


PyWa is a Fast, Simple, Modern and easy-to-use asynchronous Python framework for building WhatsApp bots using the WhatsApp Cloud API.

📄 Quick Documentation Index

Get StartedWhatsApp ClientHandlersFiltersUpdatesFlowsExamples


Features

  • 🚀 Fast and simple to use. No need to worry about the low-level details.
  • 💬 Send text messages with interactive keyboards, images, videos, documents, audio, locations, contacts, etc.
  • 📩 Receive messages, callbacks, message status updates, etc.
  • ♻️ Create, send and listen to Flows (NEW!)
  • 🔄 Built-in support for webhooks (Flask, FastAPI, etc.)
  • 🔬 Filters for handling incoming updates
  • 📄 Send and create templates
  • ✅ Fully typed, documented and tested

👨‍💻 Usage

  • Create a WhatsApp client and send a message

See Getting Started for more information.

from pywa import WhatsApp

wa = WhatsApp(
    phone_id="100458559237541",
    token="EAAEZC6hUxkTIB"
)

wa.send_message(
    to="9876543210",
    text="Hello from PyWa!"
)
  • To listen to updates, create a WhatsApp client, pass a web server app (FastAPI in this example) and register callbacks:

See Handlers for more information.

# wa.py
from pywa import WhatsApp, filters
from pywa.types import Message, CallbackButton, Button
from fastapi import FastAPI

fastapi_app = FastAPI()
wa = WhatsApp(
    phone_id="1234567890",
    token="xxxxxxx",
    server=fastapi_app,
    callback_url="https://yourdomain.com/",
    verify_token="xyz123",
    app_id=123456,
    app_secret="yyyyyy"
)

@wa.on_message(filters.matches("Hello", "Hi"))
def hello(client: WhatsApp, msg: Message):
    msg.react("👋")
    msg.reply_text(
        text=f"Hello {msg.from_user.name}!",
        buttons=[
            Button(
                title="Click me!",
                callback_data="id:123"
            )
        ]
    )

@wa.on_callback_button(filters.startswith("id"))
def click_me(client: WhatsApp, clb: CallbackButton):
    clb.reply_text("You clicked me!")
  • To run the server, use fastapi-cli (pip install "fastapi[standard]"):
fastapi dev wa.py  # see uvicorn docs for more options (port, host, reload, etc.)

💫 Async Usage

  • PyWa has async support! To use the async version, replace all the imports from pywa to pywa_async and use async/await:
# wa.py
import fastapi
from pywa_async import WhatsApp, types

fastapi_app = fastapi.FastAPI()
wa = WhatsApp(..., server=fastapi_app)

async def main():
    await wa.send_message(...)

@wa.on_message()
async def hello(_: WhatsApp, msg: types.Message):
    await msg.react("👋")
    await msg.reply(...)
fastapi dev wa.py

🎛 Installation

  • Install using pip3:
pip3 install -U pywa
  • Install from source (the bleeding edge):
pip3 install -U git+https://github.com/david-lev/pywa.git
  • If you going to use the webhook features, here is shortcut to install the required dependencies:
pip3 install -U "pywa[fastapi]"
pip3 install -U "pywa[flask]"
  • If you going to use the Flow features and want to use the default FlowRequestDecryptor and the default FlowResponseEncryptor, here is shortcut to install the required dependencies:
pip3 install -U "pywa[cryptography]"

💾 Requirements

📖 Setup and Usage

See the Documentation for detailed instructions

☑️ TODO

  • Add support for async
  • Add support for more web frameworks (Django, aiohttp, etc.)
  • Add support for flows
  • Add support for more types of updates (account_alerts, phone_number_quality_updates, template_category_updates, etc.)
  • Add more examples and guides

Feel free to open an issue if you have any suggestions. or even better - submit a PR!

⚖️ License

This project is licensed under the MIT License - see the LICENSE file for details

🔱 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

pywa-1.26.0.tar.gz (159.8 kB view details)

Uploaded Source

Built Distribution

pywa-1.26.0-py3-none-any.whl (158.7 kB view details)

Uploaded Python 3

File details

Details for the file pywa-1.26.0.tar.gz.

File metadata

  • Download URL: pywa-1.26.0.tar.gz
  • Upload date:
  • Size: 159.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for pywa-1.26.0.tar.gz
Algorithm Hash digest
SHA256 cb504c1f883d2ecc55ac66cbfef772aa285d52de667e64722f40740c5e95a4ce
MD5 b981be6a0c027cc1994a589f0dd32ddb
BLAKE2b-256 fe77504c6702d8649a5b927aaac29af2eb22c020d82eff5111a1e12a31fb9fbc

See more details on using hashes here.

File details

Details for the file pywa-1.26.0-py3-none-any.whl.

File metadata

  • Download URL: pywa-1.26.0-py3-none-any.whl
  • Upload date:
  • Size: 158.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for pywa-1.26.0-py3-none-any.whl
Algorithm Hash digest
SHA256 894d6c1f58882fc12b5fe4d5254bde17dfef5d5b3425dcdd034e8e6d78aaa19a
MD5 8b27bd29d10df9df2e3c7df262e5e1de
BLAKE2b-256 be254227e4befe1e27baad52471ec98accee6bb032a0ea6b5dcbe1c1902abb47

See more details on using hashes here.

Supported by

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