Skip to main content

An easy to use module for python developers looking to build and develop chat apps using MessengerX.io

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

Uploaded Source

Built Distribution

machaao-0.1.7-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: machaao-0.1.7.tar.gz
  • Upload date:
  • Size: 8.3 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.7.tar.gz
Algorithm Hash digest
SHA256 97f475e049e0028ad734dd5b46ba94a09aa43507f09241c0020e45a92292e1ed
MD5 8e5596049a1c57bff50ae5dba87fcba6
BLAKE2b-256 756f791dc010cdc763be6ee9a8215e6eb62f9430e3a359cff7e234314eef569b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: machaao-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 9.7 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 e6dcf56da7d3dd4e6b0e1f25b9163645df7586b893b37a24fbe112dc2160204f
MD5 3d26a464d813ddf92eaeda87ad4bc13d
BLAKE2b-256 d03cc18fed9fa4c323ee85dac9b18a7e56d67dddaf06d207d7bb684195f934bc

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