Metadata-Version: 2.1
Name: python-whatsapp-wrapper
Version: 0.1.10
Summary: Pure python project for META Whatsapp Business API wrapper.
Author-email: Sergio Pires <sergiodanpires@gmail.com>
License: MIT License
        
        Copyright (c) 2024 Sergio-Daniel-Pires
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: repository, https://www.github.com/Sergio-Daniel-Pires/python-whatsapp-wrapper
Keywords: python,whatsapp,wrapper,api
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: flask>=3.0.3
Requires-Dist: dataclasses_json>=0.6.6
Requires-Dist: cryptography>=43.0.3
Requires-Dist: pycryptodome>=3.21.0
Requires-Dist: httpx>=0.27.0
Provides-Extra: test
Requires-Dist: pytest>=1.0.0; extra == "test"
Requires-Dist: pre-commit>=3.7.1; extra == "test"
Requires-Dist: isort>=5.13.2; extra == "test"
Requires-Dist: pytest-asyncio>=0.23.5; extra == "test"
Provides-Extra: docs
Requires-Dist: sphinx>=8.0.2; extra == "docs"
Requires-Dist: furo>=2024.8.6; extra == "docs"
Requires-Dist: sphinx_copybutton>=0.5.2; extra == "docs"

🤖 Want a whatsapp bot? You're in the right place.
==================================================

.. image:: https://readthedocs.org/projects/python-whatsapp-wrapper/badge/?version=latest
    :target: https://python-whatsapp-wrapper.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. image:: https://github.com/Sergio-Daniel-Pires/python-whatsapp-wrapper/actions/workflows/test.yml/badge.svg
    :target: https://github.com/Sergio-Daniel-Pires/python-whatsapp-wrapper
    :alt: Github Actions - Tests

.. image:: https://img.shields.io/pypi/dm/python-whatsapp-wrapper
    :target: https://github.com/Sergio-Daniel-Pires/python-whatsapp-wrapper
    :alt: PyPI - Downloads

.. image:: https://img.shields.io/pypi/v/python-whatsapp-wrapper
    :target: https://pypi.org/project/python-telegram-bot/
    :alt: PyPI - Version

📖 Introduction
---------------

A high-level Python wrapper for the WhatsApp API, providing easy abstraction.

A huge thanks to `Python-Telegram-Bot`_ team for their impressive work on Telegram bots, which inspired me to create this wrapper.

📱 Whatsapp API Supports
------------------------

Tested in version ``v19.0``, but you can try older versions by changing ``api_version`` in ``whatsapp.bot.WhatsappBot.api_version``.

🛠️ Before start
---------------

Before you can create your own bots, you need to follow some steps to become a `Meta API Developer`_.

**YOU NEED**  to become a Meta developer to use their API. You can find the step-by-step guide here: `Facebook Developers WhatsApp API`_

.. warning::
    It's preferable to have an extra/new SIM card to register your business account (don't try with your personal SIM, this action will **ERASE** all your whatsapp data), but they give you some free credits to get started.

🚀 Installation
---------------

We're on PyPI! So you can easy install using:

.. code-block:: bash

    pip install python-whatsapp-wrapper

Or directly by cloning project's GitHub repository:

.. code-block:: bash

    git clone https://github.com/Sergio-Daniel-Pires/python-whatsapp-wrapper
    cd python-whatsapp-wrapper
    pip install .

🤔 How I made my own bot?
-------------------------

Our repository contains many examples that you can just click-and-run.
You might want to try ``echo_bot.py``, a bot that returns any text you send it.

📄 License
----------

MIT

.. _Meta API Developer: https://developers.facebook.com/products/whatsapp/
.. _Python-Telegram-Bot: https://github.com/python-telegram-bot/python-telegram-bot
.. _Facebook Developers WhatsApp API: https://developers.facebook.com/docs/whatsapp/getting-started
