Python Betterstack Uptime Documentation
Python Betterstack-Uptime
betterstack-uptime
is a library written in python that can assist in dealing with the Betterstack Uptime API. This is done by converting API endpoints into python objects, and translating the attributes from the API into variables.
Current endpoints implemented
Monitors
Monitor SLA
Monitor Groups
Heartbeats
Heartbeat Groups
Incidents
In future, there will be more endpoints added. These however, will need some extra code in order for them to work properly. If you desperately need another endpoint, feel free to extend the BaseAPIObject
class, and implement it!
betterstack-uptime
is free and open source software, you are free to use it, share it, modify it and share the modifications with the world.
Getting Started
Requirements
You will need the following software:
python>= 3.7
Installing
Run the following command to install the package
pip install betterstack-uptime
Usage
Just some quick boilerplate code to get you started
Get all instances
from betterstack.uptime import UptimeAPI
from betterstack.uptime.objects import Monitor
api = UptimeAPI("yourtokenhere")
monitors = Monitor.get_all_instances(api=api)
for monitor in monitors:
print(monitor.url)
Documentation
Full documentation is available at https://iwink.github.io/python-betterstack-uptime/
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to me.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
License
This project is licensed under the MIT License - see the LICENSE.md file for details