whatsapp-python 4.0.2__tar.gz → 4.3.0__tar.gz

whatsapp_python-4.3.0/CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# How to contribute
+
+First of all, thank you for considering contributing to this project! It's people like you that make it a reality and help me keep it alive and updated.
+
+If you are unsure about anything, feel free to ask me. I am here to help you.
+
+Any bug report, feature request, or code contribution is welcome. Here are some guidelines to help you get started.
+
+## Submitting changes
+
+Please open a [Pull Request](https://github.com/filipporomani/whatsapp-python/pull/new/master) with a list of what you've done (read more about [pull requests](http://help.github.com/pull-requests/)). Make sure, if possible, that all of your commits are atomic (one feature per commit).
+
+Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
+
+    $ git commit -m "feat: a brief summary of the commit
+    > 
+    > A paragraph describing what changed and its impact."
+
+
+  * This is an open source software. Keep in mind to make your code readable to others. It's sort of like driving a car: perhaps you love doing donuts when you're alone, but with passengers the goal is to make the ride as smooth as possible.
+
+There isn't any other particular guideline, feel free to contribute!

{whatsapp_python-4.0.2 → whatsapp_python-4.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: whatsapp-python
-Version: 4.0.2
+Version: 4.3.0
 Summary: Open source Python wrapper for the WhatsApp Cloud API
 Project-URL: Homepage, https://github.com/filipporomani/whatsapp-python
 Project-URL: Docs, https://github.com/filipporomani/whatsapp-python/wiki
@@ -8,7 +8,6 @@ Project-URL: Issues Reporting, https://github.com/filipporomani/whatsapp-python/
 Project-URL: Download, https://github.com/filipporomani/whatsapp-python/releases/latest
 Project-URL: Changelog, https://github.com/filipporomani/whatsapp-python/releases
 Author-email: Filippo Romani <mail@filipporomani.it>
-License-File: LICENSE
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Customer Service
 Classifier: Intended Audience :: Developers
@@ -27,10 +26,11 @@ Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
 Classifier: Topic :: Software Development :: Build Tools
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.10
+Requires-Dist: aiohttp
+Requires-Dist: asyncio
 Requires-Dist: beautifulsoup4
 Requires-Dist: fastapi
 Requires-Dist: python-dotenv
-Requires-Dist: requests
 Requires-Dist: requests-toolbelt
 Requires-Dist: uvicorn
 Description-Content-Type: text/markdown
@@ -38,7 +38,8 @@ Description-Content-Type: text/markdown
 <div align="center">
   <img src="https://gist.githubusercontent.com/boywithkeyboard/e8dc5b1810bd29e1d70346ca11d7f09d/raw/7f7eeea482f5047e62944e54182aa26c89cc299a/whatsapp_python.svg" alt="logo" width="128px">
   <h1>whatsapp-python</h1>
-  <p>Free, open-source Python wrapper for the <a href="https://developers.facebook.com/docs/whatsapp/cloud-api">WhatsApp Cloud API</a>.<br>Forked from <a href="https://github.com/Neurotech-HQ/heyoo">Neurotech-HQ/heyoo</a>.</p>
+  <p>Free, open-source Python wrapper for the <a href="https://developers.facebook.com/docs/whatsapp/cloud-api">WhatsApp Cloud API</a>.<br>Forked from <a href="https://github.com/Neurotech-HQ/heyoo">Neurotech-HQ/heyoo</a>.
+  </p>
   <img src="https://img.shields.io/badge/made%20in-italy-008751.svg?style=flat-square" alt="Made in Italy">
   <a href="https://pepy.tech/project/whatsapp-python"><img src="https://static.pepy.tech/personalized-badge/whatsapp-python?period=total&units=none&left_color=grey&right_color=blue&left_text=Downloads" alt="Downloads"></a>
   <a href="https://pepy.tech/project/whatsapp-python"><img src="https://pepy.tech/badge/whatsapp-python/month" alt="Monthly Downloads"></a>
@@ -70,24 +71,24 @@ hatch shell
 
 Documentation is available in the [wiki](https://github.com/filipporomani/whatsapp/wiki) here on GitHub.
 
-## Why choose this library?
+### Key features:
+- Modern interface using `async` and `await`
+- Full support for Graph API error handling
+- Optimized for high-load workflows using asyncronous programming
+- Always up to date
+- All of the WhatsApp chat UI features supported
 
-The main reason why I decided to fork the original library is that it uses an old version of the API, it's missing many and it's not mantained anymore.
 
-In this fork I added app events (to listen to incoming messages) and implemented an easier way to send/receive messages and media by using the `Message` object.
-The API version is always up to date and I'm always adding new features and fixing bugs.
-
-I fixed some bugs and added many features, however the library can still be improved.
-
-### Supported features:
-
-- Listening to events (messages, media, etc.)
+### All features
+- Event listener (incoming messages)
+- Async ready
+- Error handling
 - Sending messages
 - Sending messages from different numbers individually
 - Marking messages as read
 - Replying to messages
 - Reacting to messages
-- Sending Media (images, audio, video and documents)
+- Sending medias (images, audios, videos, links and documents)
 - Sending location
 - Sending interactive buttons
 - Sending template messages

{whatsapp_python-4.0.2 → whatsapp_python-4.3.0}/README.md

@@ -1,7 +1,8 @@
 <div align="center">
   <img src="https://gist.githubusercontent.com/boywithkeyboard/e8dc5b1810bd29e1d70346ca11d7f09d/raw/7f7eeea482f5047e62944e54182aa26c89cc299a/whatsapp_python.svg" alt="logo" width="128px">
   <h1>whatsapp-python</h1>
-  <p>Free, open-source Python wrapper for the <a href="https://developers.facebook.com/docs/whatsapp/cloud-api">WhatsApp Cloud API</a>.<br>Forked from <a href="https://github.com/Neurotech-HQ/heyoo">Neurotech-HQ/heyoo</a>.</p>
+  <p>Free, open-source Python wrapper for the <a href="https://developers.facebook.com/docs/whatsapp/cloud-api">WhatsApp Cloud API</a>.<br>Forked from <a href="https://github.com/Neurotech-HQ/heyoo">Neurotech-HQ/heyoo</a>.
+  </p>
   <img src="https://img.shields.io/badge/made%20in-italy-008751.svg?style=flat-square" alt="Made in Italy">
   <a href="https://pepy.tech/project/whatsapp-python"><img src="https://static.pepy.tech/personalized-badge/whatsapp-python?period=total&units=none&left_color=grey&right_color=blue&left_text=Downloads" alt="Downloads"></a>
   <a href="https://pepy.tech/project/whatsapp-python"><img src="https://pepy.tech/badge/whatsapp-python/month" alt="Monthly Downloads"></a>
@@ -33,24 +34,24 @@ hatch shell
 
 Documentation is available in the [wiki](https://github.com/filipporomani/whatsapp/wiki) here on GitHub.
 
-## Why choose this library?
+### Key features:
+- Modern interface using `async` and `await`
+- Full support for Graph API error handling
+- Optimized for high-load workflows using asyncronous programming
+- Always up to date
+- All of the WhatsApp chat UI features supported
 
-The main reason why I decided to fork the original library is that it uses an old version of the API, it's missing many and it's not mantained anymore.
 
-In this fork I added app events (to listen to incoming messages) and implemented an easier way to send/receive messages and media by using the `Message` object.
-The API version is always up to date and I'm always adding new features and fixing bugs.
-
-I fixed some bugs and added many features, however the library can still be improved.
-
-### Supported features:
-
-- Listening to events (messages, media, etc.)
+### All features
+- Event listener (incoming messages)
+- Async ready
+- Error handling
 - Sending messages
 - Sending messages from different numbers individually
 - Marking messages as read
 - Replying to messages
 - Reacting to messages
-- Sending Media (images, audio, video and documents)
+- Sending medias (images, audios, videos, links and documents)
 - Sending location
 - Sending interactive buttons
 - Sending template messages

{whatsapp_python-4.0.2 → whatsapp_python-4.3.0}/examples/reply_to_message_obj.py

@@ -4,11 +4,11 @@ from dotenv import load_dotenv
 
 if __name__ == "__main__":
     load_dotenv()
-    messenger = WhatsApp(token=getenv("TOKEN"), phone_number_id={1:"1234", 2: "5678"})
+    messenger = WhatsApp(token=getenv("TOKEN"), phone_number_id={1: "1234", 2: "5678"})
 
     data = {"your": "data"}
 
-    msg = Message(data=data, instance=messenger,sender=1)
+    msg = Message(data=data, instance=messenger, sender=1)
     msg.reply("lol")
 
     print(msg)

{whatsapp_python-4.0.2 → whatsapp_python-4.3.0}/examples/sending_audio.py

@@ -4,13 +4,12 @@ from dotenv import load_dotenv
 
 if __name__ == "__main__":
     load_dotenv()
-    messenger = WhatsApp(token=getenv("TOKEN"),
-                         phone_number_id={1:"1234", 2: "5678"})
+    messenger = WhatsApp(token=getenv("TOKEN"), phone_number_id={1: "1234", 2: "5678"})
 
     response = messenger.send_audio(
         audio="https://www.soundhelix.com/examples/mp3/SoundHelix-Song-1.mp3",
         recipient_id="255757xxxxxx",
-        sender=1
+        sender=1,
     )
 
     print(response)

{whatsapp_python-4.0.2 → whatsapp_python-4.3.0}/examples/sending_button.py

@@ -4,8 +4,7 @@ from dotenv import load_dotenv
 
 if __name__ == "__main__":
     load_dotenv()
-    messenger = WhatsApp(token=getenv("TOKEN"),
-                         phone_number_id={1:"1234", 2: "5678"})
+    messenger = WhatsApp(token=getenv("TOKEN"), phone_number_id={1: "1234", 2: "5678"})
 
     response = messenger.send_button(
         recipient_id="255757xxxxxx",
@@ -30,5 +29,5 @@ if __name__ == "__main__":
                 ],
             },
         },
-        sender=1
+        sender=1,
     )

whatsapp_python-4.3.0/examples/sending_button_async.py

@@ -0,0 +1,40 @@
+from os import getenv
+from whatsapp import AsyncWhatsApp, AsyncMessage
+import asyncio
+from dotenv import load_dotenv
+
+if __name__ == "__main__":
+    load_dotenv()
+    messenger = AsyncWhatsApp(token=getenv("TOKEN"), phone_number_id={1: "1234", 2: "5678"})
+
+    async def run_test():
+        response = await messenger.send_button(
+            recipient_id="255757xxxxxx",
+            button={
+                "header": "Header Testing",
+                "body": "Body Testing",
+                "footer": "Footer Testing",
+                "action": {
+                    "button": "Button Testing",
+                    "sections": [
+                        {
+                            "title": "iBank",
+                            "rows": [
+                                {"id": "row 1", "title": "Send Money", "description": ""},
+                                {
+                                    "id": "row 2",
+                                    "title": "Withdraw money",
+                                    "description": "",
+                                },
+                            ],
+                        }
+                    ],
+                },
+            },
+            sender=1,
+        )
+        while not response.done():
+            await asyncio.sleep(.1)
+        print(response.result())
+        
+    asyncio.run(run_test())

{whatsapp_python-4.0.2 → whatsapp_python-4.3.0}/examples/sending_document.py

@@ -5,13 +5,12 @@ from dotenv import load_dotenv
 if __name__ == "__main__":
     load_dotenv()
 
-    messenger = WhatsApp(token=getenv("TOKEN"),
-                         phone_number_id={1:"1234", 2: "5678"})
+    messenger = WhatsApp(token=getenv("TOKEN"), phone_number_id={1: "1234", 2: "5678"})
 
     response = messenger.send_document(
         document="http://www.africau.edu/images/default/sample.pdf",
         recipient_id="255757294146",
-        sender=1
+        sender=1,
     )
 
     print(response)

{whatsapp_python-4.0.2 → whatsapp_python-4.3.0}/examples/sending_image.py

@@ -1,3 +1,6 @@
+
+
+
 from os import getenv
 from whatsapp import WhatsApp
 from dotenv import load_dotenv

{whatsapp_python-4.0.2 → whatsapp_python-4.3.0}/examples/sending_location.py

@@ -4,8 +4,7 @@ from dotenv import load_dotenv
 
 if __name__ == "__main__":
     load_dotenv()
-    messenger = WhatsApp(token=getenv("TOKEN"),
-                         phone_number_id={1:"1234", 2: "5678"})
+    messenger = WhatsApp(token=getenv("TOKEN"), phone_number_id={1: "1234", 2: "5678"})
 
     response = messenger.send_location(
         lat=1.29,
@@ -13,7 +12,7 @@ if __name__ == "__main__":
         name="Singapore",
         address="Singapore",
         recipient_id="255757294146",
-        sender=1
+        sender=1,
     )
 
     print(response)

whatsapp_python-4.3.0/examples/sending_message.py

@@ -0,0 +1,14 @@
+from os import getenv
+from whatsapp import WhatsApp, Message
+from dotenv import load_dotenv
+
+if __name__ == "__main__":
+    load_dotenv()
+    messenger = WhatsApp(token=getenv("TOKEN"), phone_number_id={1: "1234", 2: "5678"})
+
+    msg = Message(
+        instance=messenger, content="Hello World!", to="919999999999", sender=1
+    )
+    response = msg.send()
+
+    print(response)

whatsapp_python-4.3.0/examples/sending_message_async.py

@@ -0,0 +1,19 @@
+from os import getenv
+from whatsapp import AsyncWhatsApp, AsyncMessage
+import asyncio
+from dotenv import load_dotenv
+
+if __name__ == "__main__":
+    load_dotenv()
+    messenger = AsyncWhatsApp(token=getenv("TOKEN"), phone_number_id={1: "1234", 2: "5678"})
+
+    msg = AsyncMessage(
+        instance=messenger, content="Hello World!", to="919999999999", sender=1
+    )
+    async def run_test():
+        response = await msg.send()
+        while not response.done():
+            await asyncio.sleep(.1)
+        print(response.result())
+        
+    asyncio.run(run_test())

{whatsapp_python-4.0.2 → whatsapp_python-4.3.0}/examples/sending_template_message.py

@@ -4,10 +4,10 @@ from dotenv import load_dotenv
 
 if __name__ == "__main__":
     load_dotenv()
-    messenger = WhatsApp(token=getenv("TOKEN"),
-                         phone_number_id={1:"1234", 2: "5678"})
+    messenger = WhatsApp(token=getenv("TOKEN"), phone_number_id={1: "1234", 2: "5678"})
 
     response = messenger.send_template(
-        "hello_world", "255757xxxxxx", components=[], lang="en_US", sender=1)
+        "hello_world", "255757xxxxxx", components=[], lang="en_US", sender=1
+    )
 
     print(response)

{whatsapp_python-4.0.2 → whatsapp_python-4.3.0}/examples/sending_video.py

@@ -4,13 +4,12 @@ from dotenv import load_dotenv
 
 if __name__ == "__main__":
     load_dotenv()
-    messenger = WhatsApp(token=getenv("TOKEN"),
-                         phone_number_id={1:"1234", 2: "5678"})
+    messenger = WhatsApp(token=getenv("TOKEN"), phone_number_id={1: "1234", 2: "5678"})
 
     response = messenger.send_video(
         video="https://www.youtube.com/watch?v=K4TOrB7at0Y",
         recipient_id="255757xxxxxx",
-        sender=1
+        sender=1,
     )
 
     print(response)

{whatsapp_python-4.0.2 → whatsapp_python-4.3.0}/examples/standalone_hook.py

@@ -9,8 +9,7 @@ app = Flask(__name__)
 
 # Load .env file
 load_dotenv("../.env")
-messenger = WhatsApp(os.getenv("TOKEN"),
-                     phone_number_id=os.getenv("ID"))
+messenger = WhatsApp(os.getenv("TOKEN"), phone_number_id=os.getenv("ID"))
 VERIFY_TOKEN = "30cca545-3838-48b2-80a7-9e43b1ae8ce4"
 
 # Logging
@@ -51,8 +50,7 @@ def hook():
                 message = msg.content
                 name = msg.name
                 logging.info("Message: %s", message)
-                m = Message(instance=messenger, to=mobile,
-                            content="Hello World")
+                m = Message(instance=messenger, to=mobile, content="Hello World")
                 m.send()
 
             elif message_type == "interactive":
@@ -62,8 +60,7 @@ def hook():
                 interactive_type = message_response.get("type")
                 message_id = message_response[interactive_type]["id"]
                 message_text = message_response[interactive_type]["title"]
-                logging.info(
-                    f"Interactive Message; {message_id}: {message_text}")
+                logging.info(f"Interactive Message; {message_id}: {message_text}")
 
             elif message_type == "location":
                 message_location = msg.location
@@ -71,8 +68,7 @@ def hook():
                     return Response(status=400)
                 message_latitude = message_location["latitude"]
                 message_longitude = message_location["longitude"]
-                logging.info("Location: %s, %s",
-                             message_latitude, message_longitude)
+                logging.info("Location: %s, %s", message_latitude, message_longitude)
 
             elif message_type == "image":
                 image = msg.image

{whatsapp_python-4.0.2 → whatsapp_python-4.3.0}/pyproject.toml

@@ -31,7 +31,7 @@ classifiers=[
 dynamic = [
   "version"
 ]
-dependencies = ["fastapi", "uvicorn", "requests_toolbelt", "requests", "python-dotenv", "BeautifulSoup4"]
+dependencies = ["fastapi", "uvicorn", "requests_toolbelt", "asyncio", "aiohttp", "python-dotenv", "BeautifulSoup4"]
 
 [project.urls]
 Homepage = "https://github.com/filipporomani/whatsapp-python"

whatsapp_python-4.3.0/tests/async_tests.py

@@ -0,0 +1,180 @@
+from whatsapp import WhatsApp, Message, AsyncWhatsApp
+from dotenv import load_dotenv
+from os import getenv
+import asyncio
+from logging import getLogger, basicConfig, DEBUG
+
+load_dotenv()
+token = getenv("GRAPH_API_TOKEN")
+phone_number_id = {1: getenv("TEST_PHONE_NUMBER_ID")}
+dest_phone_number = getenv("DEST_PHONE_NUMBER")
+
+app = AsyncWhatsApp(token=token, phone_number_id=phone_number_id, update_check=False, logger=True, debug=True)
+syncapp = WhatsApp(token=token, phone_number_id=phone_number_id, update_check=False, logger=True, debug=True)
+loop = asyncio.get_event_loop()
+msg = app.create_message(to=dest_phone_number, content="Hello world")
+
+basicConfig(level=DEBUG)
+logger = getLogger(__name__)
+
+async def run_test():
+
+    # test every single method and print the result
+    print("Testing send_text")
+    v = await msg.send()
+    # print(v)
+    # await asyncio.sleep(1)
+    # print("Getting request status")
+    # print(v.result())
+
+    print("Testing send_reply_button")
+    v = await app.send_reply_button(
+        button={
+            "type": "button",
+            "body": {"text": "This is a test button"},
+            "action": {
+                "buttons": [
+                    {
+                        "type": "reply",
+                        "reply": {"id": "b1", "title": "This is button 1"},
+                    },
+                    {
+                        "type": "reply",
+                        "reply": {"id": "b2", "title": "this is button 2"},
+                    },
+                ]
+            },
+        },
+        recipient_id=dest_phone_number,
+        sender=1,
+    )
+    print(f"send_reply_button: {v}")
+
+    print("Creating button")
+    v = app.create_button(
+        button={
+            "header": {"type": "text", "text": "your-header-content"},
+            "body": {"text": "your-text-message-content"},
+            "footer": {"text": "your-footer-content"},
+            "action": {
+                "button": "cta-button-content",
+                "sections": [
+                    {
+                        "title": "your-section-title-content",
+                        "rows": [
+                            {
+                                "id": "unique-row-identifier",
+                                "title": "row-title-content",
+                                "description": "row-description-content",
+                            }
+                        ],
+                    },
+                ],
+            },
+        },
+    )
+    print(f"create_button: {v}")
+    print("sending button")
+    v = await app.send_button(
+        {
+            "header": "Header Testing",
+            "body": "Body Testing",
+            "footer": "Footer Testing",
+            "action": {
+                "button": "cta-button-content",
+                "sections": [
+                    {
+                        "title": "your-secti",
+                        "rows": [
+                            {
+                                "id": "unique-row-",
+                                "title": "row-title-",
+                                "description": "row-description-",
+                            }
+                        ],
+                    },
+                ],
+            },
+        },
+        dest_phone_number,
+        sender=1,
+    )
+    while not v.done():
+        await asyncio.sleep(1)
+    try: app.handle(v.result())
+    except Exception as error:
+        print(f"error: {error}")
+    print("sending wrong button")
+    v = await app.send_button(
+        {
+            "header": "Header Testing",
+            
+        },
+        dest_phone_number,
+        sender=1,
+    )
+    while not v.done():
+        await asyncio.sleep(1)
+    try: app.handle(v.result())
+    except Exception as error:  
+        print(f"error: {error}")
+        raise Exception("Error")
+    
+    
+    print(f"send_button: {v}")
+    print("sending image")
+    v = await app.send_image(
+        "https://filesamples.com/samples/image/jpeg/sample_640%C3%97426.jpeg",
+        dest_phone_number,
+        sender=1,
+    )
+    print(f"send_image: {v}")
+    print("sending video")
+    v = await app.send_video(
+        "https://filesamples.com/samples/video/mp4/sample_1280x720_surfing_with_audio.mp4",
+        dest_phone_number,
+        sender=1,
+    )
+    print(f"send_video: {v}")
+    print("sending audio")
+    v = await app.send_audio(
+        "https://filesamples.com/samples/audio/mp3/Symphony%20No.6%20(1st%20movement).mp3",
+        dest_phone_number,
+        sender=1,
+    )
+    print(f"send_audio: {v}")
+    print("sending document")
+    v = await app.send_document(
+        "https://filesamples.com/samples/document/docx/sample1.docx",
+        dest_phone_number,
+        sender=1,
+    )
+    print(f"send_document: {v}")
+    print("sending location")
+    v = await app.send_location(
+        "37.7749", "-122.4194", "test", "test, test", dest_phone_number, sender=1
+    )
+    print(f"send_location: {v}")
+    print("sending template")
+    v = await app.send_template("hello_world", dest_phone_number, sender=1)
+    print(
+        f"send_template: {v}"
+    )  # this returns error if the phone number is not a test phone number
+
+
+    
+        
+    await asyncio.sleep(60)
+
+async def upload():
+    print("uploading media")
+    f = await app.upload_media(
+        getenv("TEST_IMAGE_PATH"),
+        sender=1
+    )
+    print(f"upload_media: {f}")
+    print(f)
+
+    
+asyncio.run(run_test())  
+asyncio.run(upload())