pywa 1.4.0

Python wrapper for the WhatsApp Cloud API

PyWa • Python wrapper for the WhatsApp Cloud API

---

PyWa is a Fast, Simple and Lightweight Python framework for building WhatsApp bots using the WhatsApp Cloud API. The library is designed to be easy to use, and handle all the heavy lifting for you.

📄 Quick Documentation Index

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

---

👨‍💻 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:

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='xxxxxxxxxxxxxxx',
    server=flask_app,
    verify_token='XYZXYZ',
)

@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}!',
        keyboard=[
            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]

💾 Requirements

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

📖 Setup and Usage

See the Documentation for detailed instructions

☑️ TODO

• Add tests

• Add support for async

• Move from threading

• Add support for more web frameworks (Django, etc.)

• Add support for more types of updates (account_alerts, message_template_status_updates, etc.)

• Add more examples

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