Skip to content

m9m/illustrate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

illustrate

Simplistic & powerful crypto analytics

demo.mp4
Screen Shot 2023-08-21 at 9 03 58 AM (1) Screen Shot 2023-08-21 at 9 03 40 AM

Overview:

the illustrate project is meant to give the tools necessary to paint a picture of the cryptocurrency scene. This involves tools for coin prices, coin history, NFTS, ENS data, and more, all in a graphical representation.

illustrate Discord Bot

illustrate's flagship discord bot is a minimalistic, open source Discord bot that serves as a customizable engine for server-owners and crypto enthusiasts. illustrate’s UI and setup process is easy to follow, and visually appealing as a personal or public analytics platform. With scaling in mind, the bot comes bundled with a sqlite database wrapper for higher production means, and can support dozens of servers at once. Any webhooks in a server that illustrate has access to can be linked to a type of analytic for an easy-access and plug & play setup.

Features:

  • Bitcoin Price
  • Ethereum Price
  • Ethereum Gas (discontinued as of July 2023 due to provider shutdown)
  • Edit update interval for all data, which runs asyncronously

Roadmap:

  • ENS Data
  • MATIC Data
  • Slack Bot
  • More mediums for cryptocurrency data

Installation:

illustrate's Discord bot is available through pypi by the following command

pip install illustrate

or on some mac/linux distributions

pip3 install illustrate

Example:

from illustrate import IllustrateBot, IllustrateCogs
import json

settings = {
    "discord_bot_token": "xxxxx.xxx.xxxx-xxxxx-xxxx", # edit this value
    "webhook_update_intervals": 300, # edit this value
    "coinwatch_api_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx", # edit this value
    "webhook_json_data": json.dumps({
        "username": "illustrate",
        "embeds": [
            {
                "title": "TITLE_VALUE", 
                "description": "DATA_VALUE",
                "color": 1127128
            }
        ]
    })
}
illustrate_bot = IllustrateBot(settings)
illustrate_bot.add_cog(IllustrateCogs(illustrate_bot))
illustrate_bot.run()

Legal & Third Parties Used

Discord API (Terms of Service | Developer Policy | Developer Terms)

Live Coin Watch API (Public API | Terms of Service)

ETH Gas Station API (Homepage | Parent Project)

Py-cord (Github | License)

Requests (Github | License)

Python and all of its Subsequent Standard Libraries (Homepage | License)