whatsapp-python 3.0.3__tar.gz → 3.0.4__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/PKG-INFO +17 -11
  2. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/README.md +16 -10
  3. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/pyproject.toml +1 -1
  4. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/whatsapp/constants.py +1 -1
  5. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/.github/FUNDING.yml +0 -0
  6. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/.github/ISSUE_TEMPLATE/bug_report.md +0 -0
  7. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/.github/ISSUE_TEMPLATE/custom.md +0 -0
  8. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/.github/ISSUE_TEMPLATE/feature_request.md +0 -0
  9. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/.github/dependabot.yml +0 -0
  10. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/.github/workflows/codeql.yml +0 -0
  11. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/.github/workflows/dependency-review.yml +0 -0
  12. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/.gitignore +0 -0
  13. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/.version +0 -0
  14. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/CONTRIBUTING.md +0 -0
  15. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/LICENSE +0 -0
  16. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/SECURITY.md +0 -0
  17. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/examples/example_hook_obj.py +0 -0
  18. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/examples/reply_to_message_obj.py +0 -0
  19. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/examples/sending_audio.py +0 -0
  20. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/examples/sending_button.py +0 -0
  21. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/examples/sending_document.py +0 -0
  22. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/examples/sending_image.py +0 -0
  23. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/examples/sending_location.py +0 -0
  24. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/examples/sending_message.py +0 -0
  25. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/examples/sending_template_message.py +0 -0
  26. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/examples/sending_video.py +0 -0
  27. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/examples/standalone_hook.py +0 -0
  28. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/whatsapp/__init__.py +0 -0
  29. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/whatsapp/ext/_buttons.py +0 -0
  30. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/whatsapp/ext/_media.py +0 -0
  31. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/whatsapp/ext/_message.py +0 -0
  32. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/whatsapp/ext/_property.py +0 -0
  33. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/whatsapp/ext/_send_media.py +0 -0
  34. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/whatsapp/ext/_send_others.py +0 -0
  35. {whatsapp_python-3.0.3 → whatsapp_python-3.0.4}/whatsapp/ext/_static.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: whatsapp-python
3
- Version: 3.0.3
3
+ Version: 3.0.4
4
4
  Summary: Open source Python wrapper for the WhatsApp Cloud API
5
5
  Project-URL: Homepage, https://github.com/filipporomani/whatsapp
6
6
  Project-URL: Bug Tracker, https://github.com/filipporomani/whatsapp/issues
@@ -42,20 +42,23 @@ Forked from [Neurotech-HQ/heyoo](https://github.com/Neurotech-HQ/heyoo)
42
42
  7. Sending template messages
43
43
  8. Parsing messages and media received
44
44
 
45
- ## App events
45
+ ## Docs
46
46
 
47
- Asynchronous app events are now available!
47
+ Docs are available in the [**wiki**](https://github.com/filipporomani/whatsapp/wiki) section on GitHub.
48
48
 
49
- The docs are available in the [wiki](https://github.com/filipporomani/whatsapp/wiki/App-events)
49
+ ## Why choose this library?
50
50
 
51
- Leave feedbacks/report issues freely on GitHub! I'll be glad to help you!
51
+ The main reason why I decided to fork the original library is that it uses an old version of the API and doesn't support many features.
52
52
 
53
+ In this library I added app events (to listen to incoming messages) and implemented an easier way to send/receive messages and media by creating the `Message`object.
54
+
55
+ 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.
53
56
 
54
57
  ## Installation
55
58
 
56
59
  To install the library you can either use pip (latest release version):
57
60
 
58
- ``pip install -i https://test.pypi.org/simple/ whatsapp-python==3.0.2.post1`` (the production link doesn't actually work, I'm working on this issue - #16)
61
+ ``pip install whatsapp-python``
59
62
 
60
63
  or git (latest development version):
61
64
 
@@ -65,24 +68,27 @@ cd whatsapp
65
68
  python3 setup.py install
66
69
  ```
67
70
 
68
- ## Documentation
71
+ ## Obtaining the WhatsApp API credentials
72
+
73
+ To use the WhatsApp API you need to create a Facebook Business account and a WhatsApp Business account.
69
74
 
70
- The documentation for the library is available under the [**wiki**](https://github.com/filipporomani/whatsapp/wiki) section on GitHub.
75
+ **To create an account, I recomend to follow [this video](https://youtu.be/d6lNxP2gadA?si=_hbis7aP7MoKkck0)**
71
76
 
72
77
  ## Costs of the API
73
78
 
74
79
  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.
75
80
  The first 1000 chats created are free, then there is a pay-as-you-go fee that is paid for each conversation started.
76
81
 
77
- **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!
82
+ **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.
83
+
84
+ 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).
78
85
 
79
86
  All the prices are available in the [**WhatsApp API docs**](https://developers.facebook.com/docs/whatsapp/pricing)
80
87
 
81
88
  ## Switching from `Neurotech-HQ/heyoo`
89
+ *You can ignore this if it's your first time using the library.*
82
90
  Any version >1.1.2 is incompatible with the original `heyoo` library! Be careful updating! Read the docs first!
83
91
  Any version <=1.1.2 is fully compatible with the original `heyoo` library and doesn't include any breaking change..
84
- You can ignore this warning if it's your first time using the library.
85
-
86
92
 
87
93
  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`.
88
94
  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.
@@ -20,20 +20,23 @@ Forked from [Neurotech-HQ/heyoo](https://github.com/Neurotech-HQ/heyoo)
20
20
  7. Sending template messages
21
21
  8. Parsing messages and media received
22
22
 
23
- ## App events
23
+ ## Docs
24
24
 
25
- Asynchronous app events are now available!
25
+ Docs are available in the [**wiki**](https://github.com/filipporomani/whatsapp/wiki) section on GitHub.
26
26
 
27
- The docs are available in the [wiki](https://github.com/filipporomani/whatsapp/wiki/App-events)
27
+ ## Why choose this library?
28
28
 
29
- Leave feedbacks/report issues freely on GitHub! I'll be glad to help you!
29
+ The main reason why I decided to fork the original library is that it uses an old version of the API and doesn't support many features.
30
30
 
31
+ In this library I added app events (to listen to incoming messages) and implemented an easier way to send/receive messages and media by creating the `Message`object.
32
+
33
+ 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.
31
34
 
32
35
  ## Installation
33
36
 
34
37
  To install the library you can either use pip (latest release version):
35
38
 
36
- ``pip install -i https://test.pypi.org/simple/ whatsapp-python==3.0.2.post1`` (the production link doesn't actually work, I'm working on this issue - #16)
39
+ ``pip install whatsapp-python``
37
40
 
38
41
  or git (latest development version):
39
42
 
@@ -43,24 +46,27 @@ cd whatsapp
43
46
  python3 setup.py install
44
47
  ```
45
48
 
46
- ## Documentation
49
+ ## Obtaining the WhatsApp API credentials
50
+
51
+ To use the WhatsApp API you need to create a Facebook Business account and a WhatsApp Business account.
47
52
 
48
- The documentation for the library is available under the [**wiki**](https://github.com/filipporomani/whatsapp/wiki) section on GitHub.
53
+ **To create an account, I recomend to follow [this video](https://youtu.be/d6lNxP2gadA?si=_hbis7aP7MoKkck0)**
49
54
 
50
55
  ## Costs of the API
51
56
 
52
57
  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.
53
58
  The first 1000 chats created are free, then there is a pay-as-you-go fee that is paid for each conversation started.
54
59
 
55
- **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!
60
+ **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.
61
+
62
+ 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).
56
63
 
57
64
  All the prices are available in the [**WhatsApp API docs**](https://developers.facebook.com/docs/whatsapp/pricing)
58
65
 
59
66
  ## Switching from `Neurotech-HQ/heyoo`
67
+ *You can ignore this if it's your first time using the library.*
60
68
  Any version >1.1.2 is incompatible with the original `heyoo` library! Be careful updating! Read the docs first!
61
69
  Any version <=1.1.2 is fully compatible with the original `heyoo` library and doesn't include any breaking change..
62
- You can ignore this warning if it's your first time using the library.
63
-
64
70
 
65
71
  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`.
66
72
  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.
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
4
4
 
5
5
  [project]
6
6
  name="whatsapp-python"
7
- version="3.0.3"
7
+ version="3.0.4"
8
8
  authors = [{name="Filippo Romani", email="mail@filipporomani.it"}]
9
9
  description="Open source Python wrapper for the WhatsApp Cloud API"
10
10
  readme = "README.md"
@@ -1,3 +1,3 @@
1
1
  # internal use only
2
2
 
3
- VERSION = "3.0.3"
3
+ VERSION = "3.0.4"
File without changes