kaerez/pywa

PyWa • Python wrapper for the WhatsApp Cloud API

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

📄 Quick Documentation Index

>> Get Started • WhatsApp Client • Handlers • Filters • Updates • Flows • Examples

⚡ 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

from pywa import WhatsApp

wa = WhatsApp(
    phone_id='100458559237541',
    token='xxxxxxxxxxxxxxx'
)

wa.send_message(
    to='9876543210',
    text='Hello from PyWa!'
)

Create a WhatsApp client, pass a web server app (Flask in this example) and start the webhook:

> See Handlers for more information.

from pywa import WhatsApp
from flask import Flask
from pywa.types import Message, CallbackButton, Button
from pywa.filters import text, callback

flask_app = Flask(__name__)
wa = WhatsApp(
    phone_id='1234567890',
    token='xxxxxxx',
    server=flask_app,
    callback_url='https://xyz.ngrok-free.app',
    verify_token='xyz123',
    app_id=123456,
    app_secret='yyyyyy'
)

@wa.on_message(text.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(callback.data_startswith('id'))
def click_me(client: WhatsApp, clb: CallbackButton):
    clb.reply_text('You clicked me!')

flask_app.run()  # Run the flask app to start the server

🎛 Installation

Install using pip3:

pip3 install -U pywa

Install from source (the bleeding edge):

git clone https://github.com/david-lev/pywa.git
cd pywa && pip3 install -U .

If you going to use the webhook features, here is shortcut to install the required dependencies:

pip3 install -U "pywa[flask]"
pip3 install -U "pywa[fastapi]"

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

Python 3.10 or higher - https://www.python.org

📖 Setup and Usage

See the Documentation for detailed instructions

☑️ TODO

Add support for async
Add support for more web frameworks (Django, Starlette, etc.)
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.

🙏 Acknowledgments

Pyrogram - For the design inspiration

kaerez / pywa