README.md

Cool DeFi Bot

@cool_defi_bot is an open-source telegram bot written in Python.

Features include:

• Fetch and format API data
• Report errors and feedback to Slack
• Record usage to Google Analytics
• Manage deployment with Flask application

Contributing

Please log bugs and feature requests to issues. Develop and add your own features by creating a pull request.

Deploying a local version for development

Install dependencies in a new virtual environment:

$ virtualenv env
$ source env/bin/activate
$ pip install -r requirements.txt

Create an .env file:

SLACK_KEY = xxxxx
BOT_TOKEN = xxxxx
POOLS_KEY = xxxxx
ANALYTICS_TOKEN = xxxxx

Only BOT_TOKEN is needed to run the bot, other just enable additional features, like error and feedback response via Slack and tracking command popularity via Analytics. POOLS_KEY is needed to run /pools and /deepest command - fill the form to get it.

Run the application locally:

$ python run_telegram.py

Run the application with Flask:

• Run Flask instance:

  $ python run_flask.py

• Start the bot with:

  $ curl -X POST -d '' "http://127.0.0.1:8080/start?method=Local"

• Stop the bot with:

  $ curl -X POST -d '' "http://127.0.0.1:8080/stop?method=Local"

Contact

You can contact me via mail on [email protected].