Skip to main content

Provides a simple, single import cog to add a checkable page to your bot for uptime status monitoring

Project description

Flare

An easy-to-use, dead-simple cog to add a tiny, simple, fast webpage to your bot in order to enable uptime monitoring with something like UptimeRobot.

Heavily inspired (read: mostly taken) from this StackOverflow answer: https://stackoverflow.com/a/62481294/5623598. Thanks random internet person!!

Usage

Simply install the cog with pip install flare and then import it: from Flare import Flare. Finally, load the cog with bot.add_cog(Flare(bot)) and you're off to the races!!

Take a look at http://localhost:5000/ to see the bot's status page.

Example

For an example implementation, take a look at example_bot/bot.py, where there is a minimum viable bot implementing this page.

Configuration

The cog has three env vars, but the defaults work fine for a plug and play setup. If you want to change them, here's what you need to know:

  • FLARE_PORT is the port the webserver is exposed on, and it defaults to 5000. Set it to any number to change the port to your heart's desire.
  • FLARE_PATH is the path to the page. This defaults to /, but you can change it with this var to whatever you choose.
  • FLARE_HOST is the host to listen on, defaults to None which in this case means all interfaces. You can set it to a specific IP if you would like to change this configuration.

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

flare-discord.py-1.0.0.tar.gz (2.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flare_discord.py-1.0.0-py3-none-any.whl (3.5 kB view details)

Uploaded Python 3

File details

Details for the file flare-discord.py-1.0.0.tar.gz.

File metadata

  • Download URL: flare-discord.py-1.0.0.tar.gz
  • Upload date:
  • Size: 2.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for flare-discord.py-1.0.0.tar.gz
Algorithm Hash digest
SHA256 32063b7b024a05c742664a5b54072c2765f25f1efa0279cb21821211a791c460
MD5 1b7fd2cae1222976bd6558acbce2249d
BLAKE2b-256 338fa128619c52e7b58de31e3585bf3281e1104e4df7e7c01612590f1e3c6765

See more details on using hashes here.

File details

Details for the file flare_discord.py-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: flare_discord.py-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 3.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for flare_discord.py-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7010f20d3a637e7038ab1a5488d887623a78c2dca7f374a5ebb2cf807edafc40
MD5 68abeec49400d3bc0e41d025d9a6d5d0
BLAKE2b-256 415b9f7efae593d36acc7cfe6618d9c0148ceb6544bff5686a6ad044552f0d81

See more details on using hashes here.

Supported by

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