Metadata-Version: 1.1
Name: django-chatbot
Version: 0.0.2.3
Summary: Django webhook for ChatBotAI
Home-page: https://github.com/ahmadfaizalbh/django-chatbot
Author: Ahmad Faizal B H
Author-email: ahmadfaizalbh726@gmal.com
License: MIT
Description: ==================
        Django ChatBot AI
        ==================
        
        A Django wrapper with webhook for  `ChatbotAI <https://pypi.org/project/chatbotAI/>`_
        
        
        `Example code <https://github.com/ahmadfaizalbh/WebBot>`_
        
        
        
        Installation
        ============
        ::
        
          pip install django-chatbot
          
         
        
        Usage
        ======
        For Web Bot
        -----------
        in settings.py add the following::
        
           INSTALLED_APPS = [
            ...
            'django.chatbot',
            ...
          ]
         
          CHATBOT_TEMPLATE = <ChatBotAI template file path>
          START_MESSAGE = "Welcome to ChatBotAI"
        
        
        
        in urls.py add the following::
        
          from django.chatbot.views import web_hook
          
          
          urlpatterns = [
            ...
            path("webhook/", web_hook, name="webhook"),
            ...
         ]
        
        
        Web Hook API (should authenticate before API request)
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        ::
        
          URL: /webhook/
          Method: POST
          Data: {
                  last_message_id: 5,
                  message: "what is dosa"
                }
          Response: {
                "status": "Success",
                "messages": [
                     {
                       "id": 6, "text": "what is dosa",
                       "created": "2020-03-22 19:42:59",
                       "by": "user"
                      }, {
                        "id": 7,
                        "text": "A dosa is a cooked flat thin layered rice batter, originating from South India, made from a fermented batter....",
                        "created": "2020-03-22 19:42:59",
                        "by": "bot"
                      }
                ]
          }
        
        
        
        For Microsoft Bot Framework Webhook
        -----------------------------------
        
        pip install django-background-task
        
        in settings.py add the following::
        
           INSTALLED_APPS = [
            ...
            'background_task',
            'django.chatbot',
            ...
          ]
        
          CHATBOT_TEMPLATE = <ChatBotAI template file path>
          START_MESSAGE = "Welcome to ChatBotAI"
          APP_CLIENT_ID = "<Microsoft App ID>"
          APP_CLIENT_SECRET = "<Microsoft App Secret>"
        
        
        
        in urls.py add the following::
        
          from django.chatbot.views import botframework
        
          urlpatterns = [
            ...
            path("webhook/",
                 botframework.web_hook,
                 name="botframework-webhook"),
            ...
         ]
        
Keywords: django chatbot ai webhook and django wrapper for ChatBotAI
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
