whatsapp-python 3.0.2__tar.gz → 3.0.2.post1__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 (44) hide show
  1. whatsapp_python-3.0.2.post1/.github/FUNDING.yml +3 -0
  2. whatsapp_python-3.0.2.post1/.github/ISSUE_TEMPLATE/bug_report.md +31 -0
  3. whatsapp_python-3.0.2.post1/.github/ISSUE_TEMPLATE/custom.md +10 -0
  4. whatsapp_python-3.0.2.post1/.github/ISSUE_TEMPLATE/feature_request.md +20 -0
  5. whatsapp_python-3.0.2.post1/.github/dependabot.yml +11 -0
  6. whatsapp_python-3.0.2.post1/.github/workflows/codeql.yml +73 -0
  7. whatsapp_python-3.0.2.post1/.github/workflows/dependency-review.yml +20 -0
  8. whatsapp_python-3.0.2.post1/.github/workflows/python-publish.yml +42 -0
  9. whatsapp_python-3.0.2.post1/.gitignore +131 -0
  10. whatsapp_python-3.0.2.post1/.version +1 -0
  11. whatsapp_python-3.0.2.post1/CONTRIBUTING.md +21 -0
  12. {whatsapp-python-3.0.2/whatsapp_python.egg-info → whatsapp_python-3.0.2.post1}/PKG-INFO +105 -111
  13. whatsapp_python-3.0.2.post1/SECURITY.md +13 -0
  14. whatsapp_python-3.0.2.post1/examples/example_hook_obj.py +85 -0
  15. whatsapp_python-3.0.2.post1/examples/reply_to_message_obj.py +14 -0
  16. whatsapp_python-3.0.2.post1/examples/sending_audio.py +15 -0
  17. whatsapp_python-3.0.2.post1/examples/sending_button.py +33 -0
  18. whatsapp_python-3.0.2.post1/examples/sending_document.py +16 -0
  19. whatsapp_python-3.0.2.post1/examples/sending_image.py +15 -0
  20. whatsapp_python-3.0.2.post1/examples/sending_location.py +18 -0
  21. whatsapp_python-3.0.2.post1/examples/sending_message.py +14 -0
  22. whatsapp_python-3.0.2.post1/examples/sending_template_message.py +13 -0
  23. whatsapp_python-3.0.2.post1/examples/sending_video.py +15 -0
  24. whatsapp_python-3.0.2.post1/examples/standalone_hook.py +133 -0
  25. whatsapp_python-3.0.2.post1/pyproject.toml +28 -0
  26. {whatsapp-python-3.0.2 → whatsapp_python-3.0.2.post1}/setup.py +3 -3
  27. whatsapp_python-3.0.2.post1/whatsapp/constants.py +3 -0
  28. whatsapp_python-3.0.2.post1/whatsapp/ext/_buttons.py +82 -0
  29. whatsapp_python-3.0.2.post1/whatsapp/ext/_media.py +135 -0
  30. whatsapp_python-3.0.2.post1/whatsapp/ext/_message.py +103 -0
  31. whatsapp_python-3.0.2.post1/whatsapp/ext/_property.py +5 -0
  32. whatsapp_python-3.0.2.post1/whatsapp/ext/_send_media.py +267 -0
  33. whatsapp_python-3.0.2.post1/whatsapp/ext/_send_others.py +86 -0
  34. whatsapp_python-3.0.2.post1/whatsapp/ext/_static.py +310 -0
  35. whatsapp-python-3.0.2/PKG-INFO +0 -111
  36. whatsapp-python-3.0.2/setup.cfg +0 -4
  37. whatsapp-python-3.0.2/whatsapp/constants.py +0 -3
  38. whatsapp-python-3.0.2/whatsapp_python.egg-info/SOURCES.txt +0 -10
  39. whatsapp-python-3.0.2/whatsapp_python.egg-info/dependency_links.txt +0 -1
  40. whatsapp-python-3.0.2/whatsapp_python.egg-info/requires.txt +0 -4
  41. whatsapp-python-3.0.2/whatsapp_python.egg-info/top_level.txt +0 -1
  42. {whatsapp-python-3.0.2 → whatsapp_python-3.0.2.post1}/LICENSE +0 -0
  43. {whatsapp-python-3.0.2 → whatsapp_python-3.0.2.post1}/README.md +0 -0
  44. {whatsapp-python-3.0.2 → whatsapp_python-3.0.2.post1}/whatsapp/__init__.py +0 -0
@@ -0,0 +1,3 @@
1
+ # These are supported funding model platforms
2
+
3
+ github: filipporomani
@@ -0,0 +1,31 @@
1
+ ---
2
+ name: Bug report
3
+ about: Create a report to help us improve
4
+ title: "[BUG]"
5
+ labels: ''
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ **Describe the bug**
11
+ A clear and concise description of what the bug is.
12
+
13
+ **To Reproduce**
14
+ Steps to reproduce the behavior:
15
+ 1. Go to '...'
16
+ 2. Click on '....'
17
+ 3. Scroll down to '....'
18
+ 4. See error
19
+
20
+ **Expected behavior**
21
+ A clear and concise description of what you expected to happen.
22
+
23
+ **Screenshots**
24
+ If applicable, add screenshots to help explain your problem.
25
+
26
+ **Desktop (please complete the following information):**
27
+ - OS: [e.g. iOS]
28
+ - Version [e.g. 22]
29
+
30
+ **Additional context**
31
+ Add any other context about the problem here.
@@ -0,0 +1,10 @@
1
+ ---
2
+ name: Custom issue template
3
+ about: Describe this issue template's purpose here.
4
+ title: "[OTHER]"
5
+ labels: ''
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+
@@ -0,0 +1,20 @@
1
+ ---
2
+ name: Feature request
3
+ about: Suggest an idea for this project
4
+ title: "[FEAT]"
5
+ labels: ''
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ **Is your feature request related to a problem? Please describe.**
11
+ A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12
+
13
+ **Describe the solution you'd like**
14
+ A clear and concise description of what you want to happen.
15
+
16
+ **Describe alternatives you've considered**
17
+ A clear and concise description of any alternative solutions or features you've considered.
18
+
19
+ **Additional context**
20
+ Add any other context or screenshots about the feature request here.
@@ -0,0 +1,11 @@
1
+ # To get started with Dependabot version updates, you'll need to specify which
2
+ # package ecosystems to update and where the package manifests are located.
3
+ # Please see the documentation for all configuration options:
4
+ # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5
+
6
+ version: 2
7
+ updates:
8
+ - package-ecosystem: "pip" # See documentation for possible values
9
+ directory: "/" # Location of package manifests
10
+ schedule:
11
+ interval: "daily"
@@ -0,0 +1,73 @@
1
+ # For most projects, this workflow file will not need changing; you simply need
2
+ # to commit it to your repository.
3
+ #
4
+ # You may wish to alter this file to override the set of languages analyzed,
5
+ # or to provide custom queries or build logic.
6
+ #
7
+ # ******** NOTE ********
8
+ # We have attempted to detect the languages in your repository. Please check
9
+ # the `language` matrix defined below to confirm you have the correct set of
10
+ # supported CodeQL languages.
11
+ #
12
+ name: "CodeQL"
13
+
14
+ on:
15
+ pull_request:
16
+ branches: [ "main" ]
17
+ schedule:
18
+ - cron: '0 0 * * *'
19
+
20
+ jobs:
21
+ analyze:
22
+ name: Analyze
23
+ runs-on: ubuntu-latest
24
+ permissions:
25
+ actions: read
26
+ contents: read
27
+ security-events: write
28
+
29
+ strategy:
30
+ fail-fast: false
31
+ matrix:
32
+ language: [ 'python' ]
33
+ # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
34
+ # Use only 'java' to analyze code written in Java, Kotlin or both
35
+ # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
36
+ # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
37
+
38
+ steps:
39
+ - name: Checkout repository
40
+ uses: actions/checkout@v3
41
+
42
+ # Initializes the CodeQL tools for scanning.
43
+ - name: Initialize CodeQL
44
+ uses: github/codeql-action/init@v2
45
+ with:
46
+ languages: ${{ matrix.language }}
47
+ # If you wish to specify custom queries, you can do so here or in a config file.
48
+ # By default, queries listed here will override any specified in a config file.
49
+ # Prefix the list here with "+" to use these queries and those in the config file.
50
+
51
+ # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
52
+ # queries: security-extended,security-and-quality
53
+
54
+
55
+ # Autobuild attempts to build any compiled languages (C/C++, C#, Go, or Java).
56
+ # If this step fails, then you should remove it and run the build manually (see below)
57
+ - name: Autobuild
58
+ uses: github/codeql-action/autobuild@v2
59
+
60
+ # ℹ️ Command-line programs to run using the OS shell.
61
+ # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
62
+
63
+ # If the Autobuild fails above, remove it and uncomment the following three lines.
64
+ # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
65
+
66
+ # - run: |
67
+ # echo "Run, Build Application using script"
68
+ # ./location_of_script_within_repo/buildscript.sh
69
+
70
+ - name: Perform CodeQL Analysis
71
+ uses: github/codeql-action/analyze@v2
72
+ with:
73
+ category: "/language:${{matrix.language}}"
@@ -0,0 +1,20 @@
1
+ # Dependency Review Action
2
+ #
3
+ # This Action will scan dependency manifest files that change as part of a Pull Request, surfacing known-vulnerable versions of the packages declared or updated in the PR. Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable packages will be blocked from merging.
4
+ #
5
+ # Source repository: https://github.com/actions/dependency-review-action
6
+ # Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement
7
+ name: 'Dependency Review'
8
+ on: [pull_request]
9
+
10
+ permissions:
11
+ contents: read
12
+
13
+ jobs:
14
+ dependency-review:
15
+ runs-on: ubuntu-latest
16
+ steps:
17
+ - name: 'Checkout Repository'
18
+ uses: actions/checkout@v3
19
+ - name: 'Dependency Review'
20
+ uses: actions/dependency-review-action@v2
@@ -0,0 +1,42 @@
1
+ # This workflow will upload a Python Package using Twine when a release is created
2
+ # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
3
+
4
+ # This workflow uses actions that are not certified by GitHub.
5
+ # They are provided by a third-party and are governed by
6
+ # separate terms of service, privacy policy, and support
7
+ # documentation.
8
+
9
+ name: Upload Python Package
10
+
11
+ on:
12
+ release:
13
+ types: [published]
14
+ workflow_dispatch:
15
+ inputs:
16
+ environment:
17
+ description: 'Environment to run tests against'
18
+ type: environment
19
+ required: false
20
+
21
+
22
+ permissions:
23
+ contents: read
24
+
25
+ jobs:
26
+ deploy:
27
+
28
+ runs-on: ubuntu-latest
29
+
30
+ steps:
31
+ - uses: actions/checkout@v3
32
+ - name: Set up Python
33
+ uses: actions/setup-python@v3
34
+ with:
35
+ python-version: '3.x'
36
+ - name: Build package
37
+ run: python setup.py sdist
38
+ - name: Publish package
39
+ uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
40
+ with:
41
+ user: __token__
42
+ password: ${{ secrets.PYPI_API_TOKEN }}
@@ -0,0 +1,131 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ pip-wheel-metadata/
24
+ share/python-wheels/
25
+ *.egg-info/
26
+ .installed.cfg
27
+ *.egg
28
+ MANIFEST
29
+ *.DS_Store
30
+
31
+ # PyInstaller
32
+ # Usually these files are written by a python script from a template
33
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
34
+ *.manifest
35
+ *.spec
36
+
37
+ # Installer logs
38
+ pip-log.txt
39
+ pip-delete-this-directory.txt
40
+
41
+ # Unit test / coverage reports
42
+ htmlcov/
43
+ .tox/
44
+ .nox/
45
+ .coverage
46
+ .coverage.*
47
+ .cache
48
+ nosetests.xml
49
+ coverage.xml
50
+ *.cover
51
+ *.py,cover
52
+ .hypothesis/
53
+ .pytest_cache/
54
+
55
+ # Translations
56
+ *.mo
57
+ *.pot
58
+
59
+ # Django stuff:
60
+ *.log
61
+ local_settings.py
62
+ db.sqlite3
63
+ db.sqlite3-journal
64
+
65
+ # Flask stuff:
66
+ instance/
67
+ .webassets-cache
68
+
69
+ # Scrapy stuff:
70
+ .scrapy
71
+
72
+ # Sphinx documentation
73
+ docs/_build/
74
+
75
+ # PyBuilder
76
+ target/
77
+
78
+ # Jupyter Notebook
79
+ .ipynb_checkpoints
80
+
81
+ # IPython
82
+ profile_default/
83
+ ipython_config.py
84
+
85
+ # pyenv
86
+ .python-version
87
+
88
+ # pipenv
89
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
90
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
91
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
92
+ # install all needed dependencies.
93
+ #Pipfile.lock
94
+
95
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow
96
+ __pypackages__/
97
+
98
+ # Celery stuff
99
+ celerybeat-schedule
100
+ celerybeat.pid
101
+
102
+ # SageMath parsed files
103
+ *.sage.py
104
+
105
+ # Environments
106
+ .env
107
+ .venv
108
+ env/
109
+ venv/
110
+ ENV/
111
+ env.bak/
112
+ venv.bak/
113
+
114
+ # Spyder project settings
115
+ .spyderproject
116
+ .spyproject
117
+
118
+ # Rope project settings
119
+ .ropeproject
120
+
121
+ # mkdocs documentation
122
+ /site
123
+
124
+ # mypy
125
+ .mypy_cache/
126
+ .dmypy.json
127
+ dmypy.json
128
+
129
+ # Pyre type checker
130
+ .pyre/
131
+ whatsapp/.DS_Store
@@ -0,0 +1 @@
1
+ 3.0.1
@@ -0,0 +1,21 @@
1
+ # How to contribute
2
+
3
+ I'm really glad you're reading this, because we need developers to help this project stay alive!
4
+
5
+ ## Submitting changes
6
+
7
+ Please send a [GitHub Pull Request](https://github.com/filipporomani/whatsapp/pull/new/master) with a clear list of what you've done (read more about [pull requests](http://help.github.com/pull-requests/)). Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit).
8
+
9
+ Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
10
+
11
+ $ git commit -m "A brief summary of the commit
12
+ >
13
+ > A paragraph describing what changed and its impact."
14
+
15
+ ## Coding conventions
16
+
17
+ Start reading our code and you'll get the hang of it. We optimize for readability:
18
+ * This is open source software. Consider the people who will read your code, and make it look nice for them. 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.
19
+
20
+ There isn't any other particular guideline, feel free to contribute!
21
+ Thanks!
@@ -1,111 +1,105 @@
1
- Metadata-Version: 2.1
2
- Name: whatsapp-python
3
- Version: 3.0.2
4
- Summary: Open source Python wrapper for the WhatsApp Cloud API
5
- Home-page: https://github.com/filipporomani/whatsapp
6
- Download-URL: https://github.com/filipporomani/whatsapp/releases/latest
7
- Author: Filippo Romani
8
- Author-email: mail@filipporomani.it
9
- License: MIT
10
- Keywords: whatsapp,whatsapp-libary,WhatsApp Cloud API Wrapper,PyWhatsApp,WhatsApp API in Python
11
- Classifier: Development Status :: 4 - Beta
12
- Classifier: Intended Audience :: Developers
13
- Classifier: Topic :: Software Development :: Build Tools
14
- Classifier: License :: OSI Approved :: MIT License
15
- Classifier: Programming Language :: Python :: 3.6
16
- Classifier: Programming Language :: Python :: 3.7
17
- Classifier: Programming Language :: Python :: 3.8
18
- Classifier: Programming Language :: Python :: 3.9
19
- Classifier: Programming Language :: Python :: 3.10
20
- Classifier: Programming Language :: Python :: 3.11
21
- Requires-Python: >=3.6
22
- Description-Content-Type: text/markdown
23
- License-File: LICENSE
24
- Requires-Dist: requests
25
- Requires-Dist: requests-toolbelt
26
- Requires-Dist: typing
27
- Requires-Dist: fastapi
28
-
29
- # [whatsapp-python](https://pypi.org/project/whatsapp-python/)
30
-
31
- ![Made in Italy](https://img.shields.io/badge/made%20in-italy-008751.svg?style=flat-square)
32
- [![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)
33
- [![Downloads](https://pepy.tech/badge/whatsapp-python/month)](https://pepy.tech/project/whatsapp-python)
34
- [![Downloads](https://pepy.tech/badge/whatsapp-python/week)](https://pepy.tech/project/whatsapp-python)
35
-
36
- Free, open-source Python wrapper for the [WhatsApp Cloud API](https://developers.facebook.com/docs/whatsapp/cloud-api).
37
-
38
- Forked from [Neurotech-HQ/heyoo](https://github.com/Neurotech-HQ/heyoo)
39
-
40
- ## Supported features
41
-
42
- 1. Listening to events (messages, media, etc.)
43
- 2. Sending messages
44
- 3. Marking messages as read
45
- 4. Sending Media (images, audio, video and documents)
46
- 5. Sending location
47
- 6. Sending interactive buttons
48
- 7. Sending template messages
49
- 8. Parsing messages and media received
50
-
51
- ## App events
52
-
53
- Asynchronous app events are now available!
54
-
55
- The docs are available in the [wiki](https://github.com/filipporomani/whatsapp/wiki/App-events)
56
-
57
- Leave feedbacks/report issues freely on GitHub! I'll be glad to help you!
58
-
59
-
60
- ## Installation
61
-
62
- To install the library you can either use pip (latest release version):
63
-
64
- ``pip install whatsapp-python``
65
-
66
- or git (latest development version):
67
-
68
- ```bash
69
- git clone https://github.com/filipporomani/whatsapp.git
70
- cd whatsapp
71
- python3 setup.py install
72
- ```
73
-
74
- ## Documentation
75
-
76
- The documentation for the library is available under the [**wiki**](https://github.com/filipporomani/whatsapp/wiki) section on GitHub.
77
-
78
- ## Costs of the API
79
-
80
- 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.
81
- The first 1000 chats created are free, then there is a pay-as-you-go fee that is paid for each conversation started.
82
-
83
- **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!
84
-
85
- All the prices are available in the [**WhatsApp API docs**](https://developers.facebook.com/docs/whatsapp/pricing)
86
-
87
- ## Switching from `Neurotech-HQ/heyoo`
88
- Any version >1.1.2 is incompatible with the original `heyoo` library! Be careful updating! Read the docs first!
89
- Any version <=1.1.2 is fully compatible with the original `heyoo` library and doesn't include any breaking change..
90
- You can ignore this warning if it's your first time using the library.
91
-
92
-
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`.
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.
95
-
96
- **Note**: docs for version 1.1.2 are available in the [**dedicated wiki page**](https://github.com/filipporomani/whatsapp/wiki/v1.1.2).
97
-
98
-
99
-
100
-
101
- ## Issues
102
-
103
- If you are facing any issues or have any questions, please open an issue on the [**GitHub repository**](https://github.com/filipporomani/whatsapp/issues)
104
-
105
- ## Contributing
106
-
107
- This is an opensource project published under the ```MIT License```: [**LICENSE**](LICENSE).
108
-
109
- ## References
110
-
111
- 1. [WhatsApp Cloud API official documentation](https://developers.facebook.com/docs/whatsapp/cloud-api/)
1
+ Metadata-Version: 2.1
2
+ Name: whatsapp-python
3
+ Version: 3.0.2.post1
4
+ Summary: Open source Python wrapper for the WhatsApp Cloud API
5
+ Project-URL: Homepage, https://github.com/filipporomani/whatsapp
6
+ Project-URL: Bug Tracker, https://github.com/filipporomani/whatsapp/issues
7
+ Project-URL: Download, https://github.com/filipporomani/whatsapp/releases/latest
8
+ Author-email: Filippo Romani <mail@filipporomani.it>
9
+ License-File: LICENSE
10
+ Classifier: Development Status :: 4 - Beta
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: License :: OSI Approved :: MIT License
13
+ Classifier: Programming Language :: Python :: 3.6
14
+ Classifier: Programming Language :: Python :: 3.7
15
+ Classifier: Programming Language :: Python :: 3.8
16
+ Classifier: Programming Language :: Python :: 3.9
17
+ Classifier: Programming Language :: Python :: 3.10
18
+ Classifier: Programming Language :: Python :: 3.11
19
+ Classifier: Topic :: Software Development :: Build Tools
20
+ Requires-Python: >=3.8
21
+ Description-Content-Type: text/markdown
22
+
23
+ # [whatsapp-python](https://pypi.org/project/whatsapp-python/)
24
+
25
+ ![Made in Italy](https://img.shields.io/badge/made%20in-italy-008751.svg?style=flat-square)
26
+ [![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)
27
+ [![Downloads](https://pepy.tech/badge/whatsapp-python/month)](https://pepy.tech/project/whatsapp-python)
28
+ [![Downloads](https://pepy.tech/badge/whatsapp-python/week)](https://pepy.tech/project/whatsapp-python)
29
+
30
+ Free, open-source Python wrapper for the [WhatsApp Cloud API](https://developers.facebook.com/docs/whatsapp/cloud-api).
31
+
32
+ Forked from [Neurotech-HQ/heyoo](https://github.com/Neurotech-HQ/heyoo)
33
+
34
+ ## Supported features
35
+
36
+ 1. Listening to events (messages, media, etc.)
37
+ 2. Sending messages
38
+ 3. Marking messages as read
39
+ 4. Sending Media (images, audio, video and documents)
40
+ 5. Sending location
41
+ 6. Sending interactive buttons
42
+ 7. Sending template messages
43
+ 8. Parsing messages and media received
44
+
45
+ ## App events
46
+
47
+ Asynchronous app events are now available!
48
+
49
+ The docs are available in the [wiki](https://github.com/filipporomani/whatsapp/wiki/App-events)
50
+
51
+ Leave feedbacks/report issues freely on GitHub! I'll be glad to help you!
52
+
53
+
54
+ ## Installation
55
+
56
+ To install the library you can either use pip (latest release version):
57
+
58
+ ``pip install whatsapp-python``
59
+
60
+ or git (latest development version):
61
+
62
+ ```bash
63
+ git clone https://github.com/filipporomani/whatsapp.git
64
+ cd whatsapp
65
+ python3 setup.py install
66
+ ```
67
+
68
+ ## Documentation
69
+
70
+ The documentation for the library is available under the [**wiki**](https://github.com/filipporomani/whatsapp/wiki) section on GitHub.
71
+
72
+ ## Costs of the API
73
+
74
+ 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
+ The first 1000 chats created are free, then there is a pay-as-you-go fee that is paid for each conversation started.
76
+
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!
78
+
79
+ All the prices are available in the [**WhatsApp API docs**](https://developers.facebook.com/docs/whatsapp/pricing)
80
+
81
+ ## Switching from `Neurotech-HQ/heyoo`
82
+ Any version >1.1.2 is incompatible with the original `heyoo` library! Be careful updating! Read the docs first!
83
+ 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
+
87
+ 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
+ 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.
89
+
90
+ **Note**: docs for version 1.1.2 are available in the [**dedicated wiki page**](https://github.com/filipporomani/whatsapp/wiki/v1.1.2).
91
+
92
+
93
+
94
+
95
+ ## Issues
96
+
97
+ If you are facing any issues or have any questions, please open an issue on the [**GitHub repository**](https://github.com/filipporomani/whatsapp/issues)
98
+
99
+ ## Contributing
100
+
101
+ This is an opensource project published under the ```MIT License```: [**LICENSE**](LICENSE).
102
+
103
+ ## References
104
+
105
+ 1. [WhatsApp Cloud API official documentation](https://developers.facebook.com/docs/whatsapp/cloud-api/)
@@ -0,0 +1,13 @@
1
+ # Security Policy
2
+
3
+ ## Supported Versions
4
+
5
+ | Version | Supported |
6
+ | ------- | ------------------ |
7
+ | >=1.0.2 | :white_check_mark: |
8
+ | <1.0.2 | :x: |
9
+
10
+ ## Reporting a Vulnerability
11
+
12
+ Please report any vulnerability at Filippo Romani via e-mail: mail@filipporomani.it.
13
+ I'll review vulnerabilities as soon as possible, with maximum prioirity.