Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
ahmadfaizalbh authored Mar 22, 2020
1 parent c2eb32f commit c962baa
Showing 1 changed file with 64 additions and 1 deletion.
65 changes: 64 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,71 @@
==================
Django ChatBot AI
==================

A Django wrapper with webhook for [ChatbotAI](https://pypi.org/project/chatbotAI/)
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
======
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"
}
]
}

0 comments on commit c962baa

Please sign in to comment.