textbase-framework 0.1.0

Framework for the textbase package.

textbase-framework

An add-on for the textbase repository which enables you to deploy your bots to the internet for everyone to use!

To use it, you just have to import the library and use a decorator function called bot(name="your-amazing-bot") and you can pass the name of your bot using the name parameter.

Something like:

from textbase_framework import bot, Message

@bot(name="your-amazing-bot") #The decorator function
def on_message(message_history: List[Message], state: dict = None):

    '''
    Your logic for the bot, assuming it returns bot_response


    The response HAS TO BE in the format given below so that our backend framework
    has no issues communicating with the frontend.
    '''
    
    response = {
        "data": {
            "messages": [
                {
                    "type": "string",
                    "value": bot_response
                },
                {
                    "type": "audio",
                    "value": ""
                }
            ],
            "state": state
        },
        "errors": [
            {
                "message": ""
            }
        ]
    }

    return {
        "status_code": 200,
        "response": response
    }