README.md

machaao - make personalized chatbots that scale

A module for python developers looking to rapidly build, prototype and publish personalized chatbots

Live Web Demo

Jeanie is a GPT-J powered virtual girlfriend based on the module

Minimum Requirements

python # 3.6 or higher version

Get your FREE API Key through the Dev Portal

Get your FREE API Key @ https://portal.messengerx.io

Install

# For Linux/MacOS
pip3 install machaao

# For Windows
pip install machaao

Create new chatbot project

machaao start -n <project_name>

Navigate to the newly created chatbot project directory

cd <project_name>

Open chatbot.py in any text editor, update the api key and base url as shown below

MESSENGERX_API_TOKEN = "<API_KEY_FROM_PORTAL>"
MESSENGERX_BASE_URL = "https://ganglia.machaao.com" [for development purposes]

Run your simple chatbot on your local server

# For Linux/MacOS
python3 chatbot.py

# For Windows
python chatbot.py

Start ngrok.io tunnel in a new terminal (local development)

ngrok http 5000

Update your webhook

Update your bot Webhook URL at MessengerX.io Portal with the url provided as shown below to continue development

https://<Your NGROK URL>/machaao/hook 

Your chatbot is now ready to start receiving incoming messages from users

# HappyCoding

NOTE: UNDER ACTIVE DEVELOPMENT (ACCEPTING PULL REQUESTS)