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 -s <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.1.9.tar.gz (8.6 kB view details)

Uploaded Source

Built Distribution

machaao-0.1.9-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file machaao-0.1.9.tar.gz.

File metadata

  • Download URL: machaao-0.1.9.tar.gz
  • Upload date:
  • Size: 8.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.2

File hashes

Hashes for machaao-0.1.9.tar.gz
Algorithm Hash digest
SHA256 7d1a5e5ae5b7e8e78da418c810b866b1bd1f8eac3a85d952cf30553894f3764b
MD5 d4d33dbbad27cc440fbf663a677ed4c6
BLAKE2b-256 966312e80fb9e69337791f804639732bf3d87197591bee75cdc60215e7eb250f

See more details on using hashes here.

File details

Details for the file machaao-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: machaao-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 9.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.2

File hashes

Hashes for machaao-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 7149a4f5fc28980440ed8a6a1e12e8cb4b1c764a59fa07d201a41c981c0f3ca9
MD5 4415be6b5be6cf56c336001f675c4cb0
BLAKE2b-256 20f5607327e03df488cf7d090e0929b35a7da0363707ba7e9124a1215345d191

See more details on using hashes here.

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