/edwh-uptime-plugin

UptimeRobot plugin for `edwh`

Primary LanguagePythonMIT LicenseMIT

edwh-uptime-plugin

PyPI - Version PyPI - Python Version


UptimeRobot API integration for the edwh tool.

Table of Contents

Installation

pip install edwh-uptime-plugin

But probably you want to install the whole edwh package:

pipx install edwh[uptime]
# or
pipx install edwh[plugins,omgeving]

Usage

# set your api key and see your profile info:
edwh uptime.account

# see the other available commands:
edwh help uptime

UPTIMEROBOT_APIKEY is saved in a .env file. You can also set IS_DEBUG=1 if you want to see verbose logging (every request and response).

As a Library

from edwh_uptime_plugin import tasks
from edwh_uptime_plugin.tasks import specific_task
from edwh_uptime_plugin.uptimerobot import UptimeRobot, uptime_robot

# run specific tasks via tasks.some_task or import some_task
tasks.specific_task == specific_task

# by default, the API key will be loaded from .env or prompted.
uptime_robot._api_key = "specific-key"  # before any API calls to skip .env behavior

# uptime_robot is an instance of UptimeRobot
uptime_robot.get_account_details()

License

edwh-uptime-plugin is distributed under the terms of the MIT license.