Metadata-Version: 2.1
Name: machaao
Version: 0.3.0
Summary: A module for python developers looking to build, prototype & deploy deeply personalized chatbots
Home-page: https://github.com/machaao/machaao-py
Author: Abhishek Raj
Author-email: abhishek@machaao.com
License: UNKNOWN
Description: # machaao - make personalized chatbots that scale
        [![codebeat badge](https://codebeat.co/badges/9ddf5add-675b-4816-8209-45cf29e686a3)](https://codebeat.co/projects/github-com-machaao-machaao-py-master)
        [![Gitter](https://badges.gitter.im/messengerx-io/community.svg)](https://gitter.im/messengerx-io/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)  
        A module for python developers looking to rapidly build, prototype and publish personalized chatbots
        
        ### Minimum Requirements
        ```bash
        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
        ```bash
        # For Linux/MacOS
        pip3 install machaao
        
        # For Windows
        pip install machaao
        ```
        
        ### Create new chatbot project
        ```bash
        machaao start -n <project_name>
        ```
        
        ### Navigate to the newly created chatbot project directory
        ```bash
        cd <project_name>
        ```
        
        ### Open ```chatbot.py``` in any text editor, update the api key and base url as shown below
        ```bash
        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.
        ```bash
        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
        ```bash
        # HappyCoding
        ```
        
        ## Optional 
        
        ### Run Machaao Tunnel in a seperate terminal and note down your FORWARDING URL
        ```bash
        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
        ```bash
        [https://<....>.tunnel.messengerx.io/machaao/incoming]
        ```
        
        ### Run your simple chatbot on your local server
        ```bash
        # For Linux/MacOS
        python3 chatbot.py
        
        # For Windows
        python chatbot.py
        ```
        
        
        
        #### NOTE: UNDER ACTIVE DEVELOPMENT (ACCEPTING PULL REQUESTS)
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
