Skip to main content

A module for python developers looking to build, prototype & deploy deeply personalized chatbots

Project description

machaao - make personalized chatbots that scale

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

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-dev.machaao.com" [for development purposes]

Run the following for machaao to do it's magic.

machaao run -p 5000 -t [CHATBOT-TOKEN]

Your bot should now be available @ [https://dev.messengerx.io/<chatbot_name>] to send a message to your chatbot.

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

# HappyCoding

Optional

Run Machaao Tunnel in a seperate terminal and note down your FORWARDING URL

machaao tunnel -p 5000 -t [CHATBOT-TOKEN]

[https://<....>.tunnel.messengerx.io/]

Go to your bot settings on the portal and update your Chatbot Webhook URL Settings

[https://<....>.tunnel.messengerx.io/machaao/incoming]

Run your simple chatbot on your local server

# For Linux/MacOS
python3 chatbot.py

# For Windows
python chatbot.py

NOTE: UNDER ACTIVE DEVELOPMENT (ACCEPTING PULL REQUESTS)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

machaao-0.3.5.tar.gz (9.1 kB view hashes)

Uploaded Source

Built Distribution

machaao-0.3.5-py3-none-any.whl (10.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page