pkweitai / hummingbotAI

Hummingbot AI enablement contributions from community
Other
6 stars 0 forks source link

Alt text Hummingbot AI Chatbot

Alt text

Description

This project introduces a Telegram chatbot powered by a Large Language Model (LLM), specifically designed for interacting with Hummingbot. It leverages MQTT for command execution and incorporates a robust, production-ready architecture using HayStack and Google Gemini, offering easy adaptability to other LLMs like OpenAI.

Features

Requirements

To set up the chatbot, follow these steps:

  1. Set up Google API Key Ensure that the Google API Key is set in your environment, via the .env file:

    vim .env
    
    # Put the following inside the .env file
    GOOGLE_API_KEY='your_google_api_key_here'
  2. Running Hummingbot Clone and set up Hummingbot from the official repository:

    git clone https://github.com/hummingbot/hummingbot.git
    cd hummingbot

Follow the setup instructions in the Hummingbot repository

  1. Running MQTT Broker Set up an MQTT Broker by cloning the broker repository:

    git clone git@github.com:hummingbot/brokers.git
    cd brokers
  2. Setup the MQTT remote client submodule

    git submodule update --init to fetch the submodule;
    cd hbot-remote-client && pip install .
  3. Follow the setup instructions for the broker

    • Create a Telegram Bot Create a Telegram bot using BotFather on Telegram and obtain the bot token:
    • Start a chat with BotFather (@BotFather)
    • Follow the instructions to create a new bot and get your token
    • Put the bot token as BOT_TOKEN in .env.

Installation

After setting up the requirements, install the necessary dependencies:

    pip install -r requirements.txt

    # install wkhtmltoimage
    # MAC:  brew install wkhtmltopdf
    # windows:  Go to  wkhtmltopdf download page . Download the Windows installer (e.g., wkhtmltox-0.12.6-1.msvc2015-win64.exe).

    python aihbot.py

TODO

Contributing

Contributions are welcome! Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests to us.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.