| Name | ohdear-sdk JSON |
| Version |
0.3.9
JSON |
| download |
| home_page | None |
| Summary | Oh Dear Python SDK |
| upload_time | 2023-04-18 08:44:18 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9.0 |
| license | None |
| keywords |
ohdear
sdk
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Oh Dear Python
[![Latest Version on PyPi][ico-version]][link-pypi]
[![Software License][ico-license]](LICENSE.md)
[![Build Status][ico-github-actions]][link-github-actions]
[![Buy us a tree][ico-treeware-gifting]][link-treeware-gifting]
An SDK to easily work with the [Oh Dear API](https://ohdear.app/docs/integrations/the-oh-dear-api)
## Install
Via Pip
```shell
pip install ohdear-sdk
```
## Usage
```python
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](CHANGELOG.md) for more information on what has changed recently.
## Testing
```shell
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
- [Owen Voke][link-author]
- [All Contributors][link-contributors]
## License
The MIT License (MIT). Please see [License File](LICENSE.md) 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][link-treeware-gifting].
Read more about Treeware at [treeware.earth][link-treeware].
[ico-version]: https://img.shields.io/pypi/v/ohdear-sdk.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-github-actions]: https://img.shields.io/github/actions/workflow/status/owenvoke/ohdear-python-sdk/tests.yml?branch=main&style=flat-square
[ico-treeware-gifting]: https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen?style=flat-square
[link-pypi]: https://pypi.org/project/ohdear-sdk
[link-github-actions]: https://github.com/owenvoke/ohdear-python-sdk/actions
[link-treeware]: https://treeware.earth
[link-treeware-gifting]: https://ecologi.com/owenvoke?gift-trees
[link-author]: https://github.com/owenvoke
[link-contributors]: https://github.com/owenvoke/ohdear-python-sdk/contributors
Raw data
{
"_id": null,
"home_page": null,
"name": "ohdear-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9.0",
"maintainer_email": null,
"keywords": "ohdear,sdk",
"author": null,
"author_email": "Owen Voke <development@voke.dev>",
"download_url": "https://files.pythonhosted.org/packages/1f/7b/3e702e270690054e25baf7be8da69d07657d375d66a88ab7a2e0c4dee2ca/ohdear_sdk-0.3.9.tar.gz",
"platform": null,
"description": "# Oh Dear Python\n\n[![Latest Version on PyPi][ico-version]][link-pypi]\n[![Software License][ico-license]](LICENSE.md)\n[![Build Status][ico-github-actions]][link-github-actions]\n[![Buy us a tree][ico-treeware-gifting]][link-treeware-gifting]\n\nAn SDK to easily work with the [Oh Dear API](https://ohdear.app/docs/integrations/the-oh-dear-api)\n\n## Install\n\nVia Pip\n\n```shell\npip install ohdear-sdk\n```\n\n## Usage\n\n```python\nfrom ohdear import OhDear\n\nohdear = OhDear(api_token=\"your-token\")\n\nsites = ohdear.sites.all()\n```\n\n| Available Methods | Description |\n|:---------------------------------------|:----------------------------------------------------------------------------------------------------|\n| `ohdear.me()` | Retrieve a `UserInfo` dict with details about the currently authenticated user. |\n| `ohdear.authenticated()` | Retrieve a `boolean` response indicating whether the current user is authenticated. |\n| `ohdear.broken_links.show(123)` | Retrieve a `BrokenLinksCollection` dict with details about broken links for a specific site. |\n| `ohdear.certificates.enable(123)` | Retrieve a `CertificateHealth` dict containing details about the certificate and it's health. |\n| `ohdear.checks.enable(123)` | Retrieve a `boolean` indicating whether a check was enabled successfully. |\n| `ohdear.checks.disable(123)` | Retrieve a `boolean` indicating whether a check was disabled successfully. |\n| `ohdear.cron_checks.show(123)` | Retrieve a `CronChecksCollection` dict with details about the cron checks for a specific site. |\n| `ohdear.domain_monitoring.domain(123)` | Retrieve a `Domain` dict with details about the domain for a specific site. |\n| `ohdear.mixed_contents.show(123)` | Retrieve a `MixedContentsCollection` dict with details about the mixed content for a specific site. |\n| `ohdear.sites.all()` | Retrieve a `SitesCollection` dict with details about all sites. |\n| `ohdear.sites.show(123)` | Retrieve a `Site` dict with details about a specific site. |\n\n## Change log\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.\n\n## Testing\n\n```shell\nhatch shell\n\nhatch run test\n```\n\n## Security\n\nIf you discover any security related issues, please email security@voke.dev instead of using the issue tracker.\n\n## Credits\n\n- [Owen Voke][link-author]\n- [All Contributors][link-contributors]\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n\n## Treeware\n\nYou're free to use this package, but if it makes it to your production environment you are required to buy the world a tree.\n\nIt\u2019s 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\u2019ll be creating employment for local families and restoring wildlife habitats.\n\nYou can buy trees [here][link-treeware-gifting].\n\nRead more about Treeware at [treeware.earth][link-treeware].\n\n[ico-version]: https://img.shields.io/pypi/v/ohdear-sdk.svg?style=flat-square\n[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square\n[ico-github-actions]: https://img.shields.io/github/actions/workflow/status/owenvoke/ohdear-python-sdk/tests.yml?branch=main&style=flat-square\n[ico-treeware-gifting]: https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen?style=flat-square\n\n[link-pypi]: https://pypi.org/project/ohdear-sdk\n[link-github-actions]: https://github.com/owenvoke/ohdear-python-sdk/actions\n[link-treeware]: https://treeware.earth\n[link-treeware-gifting]: https://ecologi.com/owenvoke?gift-trees\n[link-author]: https://github.com/owenvoke\n[link-contributors]: https://github.com/owenvoke/ohdear-python-sdk/contributors\n",
"bugtrack_url": null,
"license": null,
"summary": "Oh Dear Python SDK",
"version": "0.3.9",
"split_keywords": [
"ohdear",
"sdk"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "04368fe3979bcbd602cdc07952a720f44f5229b81ceac38493c0af1aa377765e",
"md5": "d89f4b8869a6316428baa40a273751ed",
"sha256": "c7e12e7065eda1decb31f98c80293dfc595c7e1712b056053acf72f2379929eb"
},
"downloads": -1,
"filename": "ohdear_sdk-0.3.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d89f4b8869a6316428baa40a273751ed",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.0",
"size": 5772,
"upload_time": "2023-04-18T08:44:20",
"upload_time_iso_8601": "2023-04-18T08:44:20.098231Z",
"url": "https://files.pythonhosted.org/packages/04/36/8fe3979bcbd602cdc07952a720f44f5229b81ceac38493c0af1aa377765e/ohdear_sdk-0.3.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1f7b3e702e270690054e25baf7be8da69d07657d375d66a88ab7a2e0c4dee2ca",
"md5": "3bb63fd261037772981d1c6619a41a91",
"sha256": "31ba785aedb7e37947559eadcd451078c58c0be16d536f6eec14aefb4ea64c77"
},
"downloads": -1,
"filename": "ohdear_sdk-0.3.9.tar.gz",
"has_sig": false,
"md5_digest": "3bb63fd261037772981d1c6619a41a91",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.0",
"size": 5804,
"upload_time": "2023-04-18T08:44:18",
"upload_time_iso_8601": "2023-04-18T08:44:18.950909Z",
"url": "https://files.pythonhosted.org/packages/1f/7b/3e702e270690054e25baf7be8da69d07657d375d66a88ab7a2e0c4dee2ca/ohdear_sdk-0.3.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-18 08:44:18",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "ohdear-sdk"
}
