python-whatsapp-wrapper


Namepython-whatsapp-wrapper JSON
Version 0.1.0 PyPI version JSON
download
home_pageNone
SummaryPure python project for META Whatsapp Business API wrapper.
upload_time2024-08-30 00:39:55
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT 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.
keywords python whatsapp wrapper api
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            🤖 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

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "python-whatsapp-wrapper",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "python, whatsapp, wrapper, api",
    "author": null,
    "author_email": "Sergio Pires <sergiodanpires@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/44/1c/363d86a1b023977a806a487c841af96f5644b337634b10c4043d5ba574ec/python_whatsapp_wrapper-0.1.0.tar.gz",
    "platform": null,
    "description": "\ud83e\udd16 Want a whatsapp bot? You're in the right place.\n==================================================\n\n.. image:: https://readthedocs.org/projects/python-whatsapp-wrapper/badge/?version=latest\n    :target: https://python-whatsapp-wrapper.readthedocs.io/en/latest/?badge=latest\n    :alt: Documentation Status\n\n.. image:: https://github.com/Sergio-Daniel-Pires/python-whatsapp-wrapper/actions/workflows/test.yml/badge.svg\n    :target: https://github.com/Sergio-Daniel-Pires/python-whatsapp-wrapper\n    :alt: Github Actions - Tests\n\n.. image:: https://img.shields.io/pypi/dm/python-whatsapp-wrapper\n    :target: https://github.com/Sergio-Daniel-Pires/python-whatsapp-wrapper\n    :alt: PyPI - Downloads\n\n.. image:: https://img.shields.io/pypi/v/python-whatsapp-wrapper\n    :target: https://pypi.org/project/python-telegram-bot/\n    :alt: PyPI - Version\n\n\ud83d\udcd6 Introduction\n---------------\n\nA high-level Python wrapper for the WhatsApp API, providing easy abstraction.\n\nA huge thanks to `Python-Telegram-Bot`_ team for their impressive work on Telegram bots, which inspired me to create this wrapper.\n\n\ud83d\udcf1 Whatsapp API Supports\n------------------------\n\nTested in version ``v19.0``, but you can try older versions by changing ``api_version`` in ``whatsapp.bot.WhatsappBot.api_version``.\n\n\ud83d\udee0\ufe0f Before start\n---------------\n\nBefore you can create your own bots, you need to follow some steps to become a `Meta API Developer`_.\n\n**YOU NEED**  to become a Meta developer to use their API. You can find the step-by-step guide here: `Facebook Developers WhatsApp API`_\n\n.. warning::\n    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.\n\n\ud83d\ude80 Installation\n---------------\n\nWe're on PyPI! So you can easy install using:\n\n.. code-block:: bash\n\n    pip install python-whatsapp-wrapper\n\nOr directly by cloning project's GitHub repository:\n\n.. code-block:: bash\n\n    git clone https://github.com/Sergio-Daniel-Pires/python-whatsapp-wrapper\n    cd python-whatsapp-wrapper\n    pip install .\n\n\ud83e\udd14 How I made my own bot?\n-------------------------\n\nOur repository contains many examples that you can just click-and-run.\nYou might want to try ``echo_bot.py``, a bot that returns any text you send it.\n\n\ud83d\udcc4 License\n----------\n\nMIT\n\n.. _Meta API Developer: https://developers.facebook.com/products/whatsapp/\n.. _Python-Telegram-Bot: https://github.com/python-telegram-bot/python-telegram-bot\n.. _Facebook Developers WhatsApp API: https://developers.facebook.com/docs/whatsapp/getting-started\n",
    "bugtrack_url": null,
    "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. ",
    "summary": "Pure python project for META Whatsapp Business API wrapper.",
    "version": "0.1.0",
    "project_urls": {
        "repository": "https://www.github.com/Sergio-Daniel-Pires/python-whatsapp-wrapper"
    },
    "split_keywords": [
        "python",
        " whatsapp",
        " wrapper",
        " api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "74ce1e56d0f467ddf79d3071bc2391ca60b2ff2b55e232c3e69edd61b5d9f654",
                "md5": "9fa0da32b4545979204d68ca4a495216",
                "sha256": "617f5b5214af5d1880bd09af31c812850717abd8d330dea7bc4d2c5046ce1e3a"
            },
            "downloads": -1,
            "filename": "python_whatsapp_wrapper-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9fa0da32b4545979204d68ca4a495216",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 16361,
            "upload_time": "2024-08-30T00:39:53",
            "upload_time_iso_8601": "2024-08-30T00:39:53.876779Z",
            "url": "https://files.pythonhosted.org/packages/74/ce/1e56d0f467ddf79d3071bc2391ca60b2ff2b55e232c3e69edd61b5d9f654/python_whatsapp_wrapper-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "441c363d86a1b023977a806a487c841af96f5644b337634b10c4043d5ba574ec",
                "md5": "610e586abef920c0d7e3089611636389",
                "sha256": "3b0f33b1b2691481945dec12d610dc0c1566413a40f33c0395910fbe7cb0299d"
            },
            "downloads": -1,
            "filename": "python_whatsapp_wrapper-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "610e586abef920c0d7e3089611636389",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 13899,
            "upload_time": "2024-08-30T00:39:55",
            "upload_time_iso_8601": "2024-08-30T00:39:55.406637Z",
            "url": "https://files.pythonhosted.org/packages/44/1c/363d86a1b023977a806a487c841af96f5644b337634b10c4043d5ba574ec/python_whatsapp_wrapper-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-30 00:39:55",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Sergio-Daniel-Pires",
    "github_project": "python-whatsapp-wrapper",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "python-whatsapp-wrapper"
}
        
Elapsed time: 0.59924s