Skip to content

owenvoke/ohdear-python-sdk

Repository files navigation

Oh Dear Python

Latest Version on PyPi Software License Build Status Buy us a tree

An SDK to easily work with the Oh Dear API

Install

Via Pip

pip install ohdear-sdk

Usage

from ohdear import OhDear

ohdear = OhDear(api_token="your-token")

sites = ohdear.sites.all()
Available Methods Description
ohdear.me() Retrieve a UserInfo dict with details about the currently authenticated user.
ohdear.authenticated() Retrieve a boolean response indicating whether the current user is authenticated.
ohdear.broken_links.show(123) Retrieve a BrokenLinksCollection dict with details about broken links for a specific site.
ohdear.certificates.enable(123) Retrieve a CertificateHealth dict containing details about the certificate and it's health.
ohdear.checks.enable(123) Retrieve a boolean indicating whether a check was enabled successfully.
ohdear.checks.disable(123) Retrieve a boolean indicating whether a check was disabled successfully.
ohdear.cron_checks.show(123) Retrieve a CronChecksCollection dict with details about the cron checks for a specific site.
ohdear.domain_monitoring.domain(123) Retrieve a Domain dict with details about the domain for a specific site.
ohdear.mixed_contents.show(123) Retrieve a MixedContentsCollection dict with details about the mixed content for a specific site.
ohdear.sites.all() Retrieve a SitesCollection dict with details about all sites.
ohdear.sites.show(123) Retrieve a Site dict with details about a specific site.

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

hatch shell

hatch run test

Security

If you discover any security related issues, please email security@voke.dev instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

Treeware

You're free to use this package, but if it makes it to your production environment you are required to buy the world a tree.

It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you support this package and contribute to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

You can buy trees here.

Read more about Treeware at treeware.earth.