diff --git a/README.md b/README.md index 623361b..aa931cc 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,28 @@ -# [whatsapp-python](https://pypi.org/project/whatsapp-python/) +
+ logo +

whatsapp-python

+

Free, open-source Python wrapper for the WhatsApp Cloud API.
Forked from Neurotech-HQ/heyoo.

+ Made in Italy + Downloads + Monthly Downloads + Weekly Downloads +
-![Made in Italy](https://img.shields.io/badge/made%20in-italy-008751.svg?style=flat-square) -[![Downloads](https://static.pepy.tech/personalized-badge/whatsapp-python?period=total&units=none&left_color=grey&right_color=blue&left_text=Downloads)](https://pepy.tech/project/whatsapp-python) -[![Downloads](https://pepy.tech/badge/whatsapp-python/month)](https://pepy.tech/project/whatsapp-python) -[![Downloads](https://pepy.tech/badge/whatsapp-python/week)](https://pepy.tech/project/whatsapp-python) - -Free, open-source Python wrapper for the [WhatsApp Cloud API](https://developers.facebook.com/docs/whatsapp/cloud-api). +## Installation -Forked from [Neurotech-HQ/heyoo](https://github.com/Neurotech-HQ/heyoo) +To install the library you can either use pip (latest release version): -## Supported features +``pip install whatsapp-python`` -1. Listening to events (messages, media, etc.) -2. Sending messages -3. Marking messages as read -4. Sending Media (images, audio, video and documents) -5. Sending location -6. Sending interactive buttons -7. Sending template messages -8. Parsing messages and media received +or git (latest development version): -## Docs +```bash +git clone https://github.com/filipporomani/whatsapp.git +cd whatsapp +python3 setup.py install +``` -Docs are available in the [**wiki**](https://github.com/filipporomani/whatsapp/wiki) section on GitHub. +Documentation is available in the [wiki section](https://github.com/filipporomani/whatsapp/wiki) on GitHub. ## Why choose this library? @@ -32,58 +32,54 @@ In this library I added app events (to listen to incoming messages) and implemen I fixed some bugs and added some features, but the library still needs a lot of work to be done even if it's working and usable. -## Installation - -To install the library you can either use pip (latest release version): - -``pip install whatsapp-python`` - -or git (latest development version): +### Supported features: -```bash -git clone https://github.com/filipporomani/whatsapp.git -cd whatsapp -python3 setup.py install -``` +- Listening to events (messages, media, etc.) +- Sending messages +- Marking messages as read +- Sending Media (images, audio, video and documents) +- Sending location +- Sending interactive buttons +- Sending template messages +- Parsing messages and media received ## Obtaining the WhatsApp API credentials To use the WhatsApp API you need to create a Facebook Business account and a WhatsApp Business account. -**To create an account, I recomend to follow [this video](https://youtu.be/d6lNxP2gadA?si=_hbis7aP7MoKkck0)** - -## Costs of the API +> [!TIP] +> To create an account, I recommend to follow [this video](https://youtu.be/d6lNxP2gadA). -While using third-party API providers of the WhatsApp API may have some monthly fees, using the WhatsApp API provided directly by Facebook is way cheaper, even if the billing docs are pretty hard to understand. -The first 1000 chats created are free, then there is a pay-as-you-go fee that is paid for each conversation started. +## Pricing of the API -**IMPORTANT**: it is now mandatory (at least it was for me) to add a credit card to the whatsapp account to use the service. I eventually got billed for using a non-test number (~1,20€), so be carefull using the API! I'm not responsible for any costs you may have using the API. +Whereas using third-party providers of the WhatsApp API can result in monthly fees, using the WhatsApp API[^1] offered directly by Facebook is much cheaper, even if the billing documentation is quite difficult to understand. -A suggestion I can give you is to use a test number (you can get one for free and use it for testing purposes only). +> [!CAUTION] +> It is now mandatory to add a credit card to the WhatsApp account (at least for me) in order to use the service. I was even charged a fee for using a non-test phone number (~€1.20), so be careful when using the API! I'm not responsible for any costs you may face by using the API. -All the prices are available in the [**WhatsApp API docs**](https://developers.facebook.com/docs/whatsapp/pricing) +All the prices are available in the [**WhatsApp API docs**](https://developers.facebook.com/docs/whatsapp/pricing). -## Switching from `Neurotech-HQ/heyoo` -*You can ignore this if it's your first time using the library.* -Any version >1.1.2 is incompatible with the original `heyoo` library! Be careful updating! Read the docs first! -Any version <=1.1.2 is fully compatible with the original `heyoo` library and doesn't include any breaking change.. +> [!TIP] +> One recommendation I can give you is to use a test number (you can get a free phone number and use it for testing purposes only). -Switching from heyoo to whatsapp-python doesn't require any change for versions up to 1.1.2: just uninstall `heyoo`, install `whatsapp-python==1.1.2` and change the import name from `heyoo` to `whatsapp`. -For version which are GREATER THEN 1.1.2, messages have became objects, so you need to change your code to use the new methods. - -**Note**: docs for version 1.1.2 are available in the [**dedicated wiki page**](https://github.com/filipporomani/whatsapp/wiki/v1.1.2). +## Migrating from `Neurotech-HQ/heyoo` +*You can ignore this if it's your first time using the library.* +- Any version >1.1.2 is incompatible with the original `heyoo` library! Be careful updating! Read the docs first! +- Any version <=1.1.2 is fully compatible with the original `heyoo` library and doesn't include breaking changes. +Switching from heyoo to whatsapp-python doesn't require any change for versions up to 1.1.2: just uninstall `heyoo`, install `whatsapp-python==1.1.2` and change the import name from `heyoo` to `whatsapp`. -## Issues +For versions GREATER THAN 1.1.2, messages have became objects, so you need to change your code to use the new methods. -If you are facing any issues or have any questions, please open an issue on the [**GitHub repository**](https://github.com/filipporomani/whatsapp/issues) +> [!NOTE] +> Documentation for version 1.1.2 can be found [here](https://github.com/filipporomani/whatsapp/wiki/v1.1.2). ## Contributing -This is an opensource project published under the ```MIT License```: [**LICENSE**](LICENSE). +If you are facing any issues or have any questions, please [open a new issue](https://github.com/filipporomani/whatsapp/issues/new/choose)! -## References +*This is an open source project published under the [MIT License](LICENSE).* -1. [WhatsApp Cloud API official documentation](https://developers.facebook.com/docs/whatsapp/cloud-api/) +[^1]: https://developers.facebook.com/docs/whatsapp/cloud-api