Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/david-lev/pywa
🤖 Hey there! I am using PyWa.
https://github.com/david-lev/pywa
pywa wa wa-cloud-api wapy whatsapp whatsapp-api whatsapp-api-python whatsapp-bot whatsapp-chat whatsapp-chatbot whatsapp-cloud-api whatsapp-cloud-api-flows whatsapp-flows whatsappbot
Last synced: 4 days ago
JSON representation
🤖 Hey there! I am using PyWa.
- Host: GitHub
- URL: https://github.com/david-lev/pywa
- Owner: david-lev
- License: mit
- Created: 2023-06-11T21:23:12.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-29T13:48:56.000Z (4 months ago)
- Last Synced: 2024-10-29T17:29:36.580Z (4 months ago)
- Topics: pywa, wa, wa-cloud-api, wapy, whatsapp, whatsapp-api, whatsapp-api-python, whatsapp-bot, whatsapp-chat, whatsapp-chatbot, whatsapp-cloud-api, whatsapp-cloud-api-flows, whatsapp-flows, whatsappbot
- Language: Python
- Homepage: https://pywa.readthedocs.io
- Size: 2.28 MB
- Stars: 226
- Watchers: 9
- Forks: 33
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
________________________
# [PyWa](https://github.com/david-lev/pywa) • Python wrapper for the WhatsApp Cloud API
[](https://pypi.org/project/pywa/)
[](https://pypi.org/project/pywa/)
[](https://github.com/david-lev/pywa/actions/workflows/tests.yml)
[](https://codecov.io/gh/david-lev/pywa)
[](https://pywa.readthedocs.io)
[](https://github.com/david-lev/pywa/blob/master/LICENSE)
[](https://www.codefactor.io/repository/github/david-lev/pywa/overview/master)
[](https://t.me/py_wa)________________________
**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 Started](https://pywa.readthedocs.io/en/latest/content/getting-started.html)
• [WhatsApp Client](https://pywa.readthedocs.io/en/latest/content/client/overview.html)
• [Handlers](https://pywa.readthedocs.io/en/latest/content/handlers/overview.html)
• [Listeners](https://pywa.readthedocs.io/en/latest/content/listeners/overview.html)
• [Filters](https://pywa.readthedocs.io/en/latest/content/filters/overview.html)
• [Updates](https://pywa.readthedocs.io/en/latest/content/updates/overview.html)
• [Flows](https://pywa.readthedocs.io/en/latest/content/flows/overview.html)
• [Examples](https://pywa.readthedocs.io/en/latest/content/examples/overview.html)------------------------
⚡ **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](https://pywa.readthedocs.io/en/latest/content/getting-started.html) for more information.```python
from pywa import WhatsAppwa = 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](https://fastapi.tiangolo.com/) in this example) and register callbacks:
> See [Handlers](https://pywa.readthedocs.io/en/latest/content/handlers/overview.html) for more information.
```python
# wa.py
from pywa import WhatsApp, filters, types
from fastapi import FastAPIfastapi_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: types.Message):
msg.react("👋")
msg.reply_text(
text=f"Hello {msg.from_user.name}!",
buttons=[
types.Button(
title="Click me!",
callback_data="id:123"
)
]
)@wa.on_callback_button(filters.startswith("id"))
def click_me(client: WhatsApp, clb: types.CallbackButton):
clb.reply_text("You clicked me!")
```- To run the server, use [fastapi-cli](https://fastapi.tiangolo.com/#run-it) (`pip install "fastapi[standard]"`):
```bash
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`:
```python
# wa.py
import fastapi
from pywa_async import WhatsApp, typesfastapi_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(...)
``````bash
fastapi dev wa.py
```🎛 **Installation**
--------------------- **Install using pip3:**
```bash
pip3 install -U pywa
```- **Install from source (the bleeding edge):**
```bash
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:**
```bash
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:**
```bash
pip3 install -U "pywa[cryptography]"
```💾 **Requirements**
--------------------- Python 3.10 or higher - https://www.python.org
📖 **Setup and Usage**
-----------------------See the [Documentation](https://pywa.readthedocs.io/) 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 guidesFeel 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](https://github.com/david-lev/pywa/blob/master/LICENSE) file for details🔱 **Contributing**
--------------------Contributions are welcome! Please see the [Contributing Guide](https://github.com/david-lev/pywa/blob/master/CONTRIBUTING.md) for more information.