Skip to main content

Simplistic & powerful crypto analytics through Discord

Project description

illustrate

Simplistic & powerful crypto analytics through Discord

Overview:

illustrate is a minimalistic, open source Discord bot that serves as a customizable front-end 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 availability in mind, the bot comes bundled with a sqlite database wrapper for higher production means, and can support dozens of servers at once.

Features:

  • Front-end interface through Discord API, with the ability to run under a personal bot key
  • Bundled bot, scraper, and sqlite wrapper
  • Production ready and scalable to dozens of servers

Installation:

illustrate 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",
    "webhook_update_intervals": 300,
    "coinwatch_api_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
    "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()

Disclaimer and Acknowledgements:

This project utilizes third party API services and linked libraries. None of these services specifically approve or are affiliated with the illustrate project, and they are all acknowledged & thanked below for their use in this project:

Third Party Services

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)

Linked Libraries

Py-cord (Github | License)

Requests (Github | License)

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

illustrate-1.0.1.tar.gz (9.6 kB view details)

Uploaded Source

File details

Details for the file illustrate-1.0.1.tar.gz.

File metadata

  • Download URL: illustrate-1.0.1.tar.gz
  • Upload date:
  • Size: 9.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for illustrate-1.0.1.tar.gz
Algorithm Hash digest
SHA256 73aebefdb882b7bef22268c0106fcb7ed950bbdcddea72f591072662f31375f4
MD5 46d1002aeff076b38ec103d9bb2dc001
BLAKE2b-256 9964ebc7cebe60c75c46413aa8ca930517503e2335521d1c86867b97cb3ddb37

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page