https://github.com/educationwarehouse/edwh-uptime-plugin
UptimeRobot plugin for `edwh`
https://github.com/educationwarehouse/edwh-uptime-plugin
edwh invoke uptime-robot
Last synced: about 1 year ago
JSON representation
UptimeRobot plugin for `edwh`
- Host: GitHub
- URL: https://github.com/educationwarehouse/edwh-uptime-plugin
- Owner: educationwarehouse
- License: mit
- Created: 2024-01-10T11:54:26.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-09T08:45:14.000Z (about 2 years ago)
- Last Synced: 2024-04-09T09:49:58.749Z (about 2 years ago)
- Topics: edwh, invoke, uptime-robot
- Language: Python
- Homepage:
- Size: 104 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# edwh-uptime-plugin
[](https://pypi.org/project/edwh-uptime-plugin)
[](https://pypi.org/project/edwh-uptime-plugin)
-----
UptimeRobot API integration for the `edwh` tool.
**Table of Contents**
- [Installation](#installation)
- [License](#license)
## Installation
```console
pip install edwh-uptime-plugin
```
But probably you want to install the whole edwh package:
```console
pipx install edwh[uptime]
# or
pipx install edwh[plugins,omgeving]
```
## Usage
```bash
# 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
```python
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](https://spdx.org/licenses/MIT.html) license.