deps: bump pytest from 7.4.4 to 8.3.5

Bumps [pytest](https://github.com/pytest-dev/pytest) from 7.4.4 to 8.3.5.
- [Release notes](https://github.com/pytest-dev/pytest/releases)
- [Changelog](https://github.com/pytest-dev/pytest/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/pytest-dev/pytest/compare/7.4.4...8.3.5)

---
updated-dependencies:
- dependency-name: pytest
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

.flake8

@@ -1,5 +1,7 @@
+
 [flake8]
-select = B,B9,C,D,DAR,E,F,N,RST,S,W
+# Eventually would add D and DAR
+select = B,B9,C,E,F,N,RST,S,W
 ignore = E203,E501,RST201,RST203,RST301,W503,B902,N805,DAR402
 max-line-length = 119
 max-complexity = 10

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/dependabot.yml

@@ -4,15 +4,23 @@ updates:
     directory: "/"
     schedule:
       interval: daily
+    commit-message:
+      prefix: ci
   - package-ecosystem: pip
     directory: "/.github/workflows"
     schedule:
       interval: daily
+    commit-message:
+      prefix: ci
   - package-ecosystem: pip
     directory: "/docs"
     schedule:
       interval: daily
+    commit-message:
+      prefix: docs
   - package-ecosystem: pip
     directory: "/"
     schedule:
       interval: daily
+    commit-message:
+      prefix: deps

.github/workflows/constraints.txt

@@ -1,6 +1,6 @@
-pip==21.3.1
-nox==2021.10.1
-nox-poetry==0.9.0
-poetry==1.1.12
-virtualenv==20.10.0
-poetry-dynamic-versioning==0.13.1
+pip==24.2
+nox==2024.10.9
+nox-poetry==1.0.3
+poetry==1.8.4
+virtualenv==20.27.1
+toml==0.10.2

.github/workflows/dependabot-auto-merge.yml

@@ -0,0 +1,14 @@
+name: Auto Merge Dependabot
+
+on:
+  pull_request:
+
+jobs:
+  auto-merge:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ahmadnassri/action-dependabot-auto-merge@v2
+        with:
+          target: minor
+          github-token: ${{ secrets.THIS_PAT }}

.github/workflows/issues.yml

@@ -0,0 +1,23 @@
+name: Issues to Discord
+on:
+  issues:
+    types:
+      - opened
+      - reopened
+      - deleted
+      - closed
+jobs:
+  issue-to-discord:
+    name: issue-to-discord
+    runs-on: ubuntu-latest
+    steps:
+      - name: Post to discord
+        uses: Ilshidur/action-discord@0.3.2
+        env:
+          DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK_ISSUES }}
+          ACTION: ${{ github.event.action }}
+          REPO: ${{ github.repository }}
+          ISSUE_URL: ${{ github.event.issue.html_url }}
+          ISSUE_USER: ${{ github.event.issue.user.login }}
+        with:
+          args: "{{ REPO }} had an issue {{ ACTION }} by {{ ISSUE_USER }} at {{ ISSUE_URL }}."

.github/workflows/labeler.yml

@@ -4,16 +4,15 @@ on:
   push:
     branches:
       - main
-      - master
 
 jobs:
   labeler:
     runs-on: ubuntu-latest
     steps:
       - name: Check out the repository
-        uses: actions/checkout@v2.4.0
+        uses: actions/checkout@v4
 
       - name: Run Labeler
-        uses: crazy-max/ghaction-github-labeler@v3.1.1
+        uses: crazy-max/ghaction-github-labeler@v5.1.0
         with:
           skip-delete: true

.github/workflows/pre-release.yml

@@ -10,12 +10,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out the repository
-        uses: actions/checkout@v2.4.0
+        uses: actions/checkout@v4
         with:
           fetch-depth: 2
 
       - name: Set up Python
-        uses: actions/setup-python@v2.3.1
+        uses: actions/setup-python@v5.3.0
         with:
           python-version: "3.10"
 
@@ -34,8 +34,7 @@ jobs:
           poetry build --ansi
 
       - name: Publish package on TestPyPI
-        if: "! steps.check-version.outputs.tag"
-        uses: pypa/gh-action-pypi-publish@v1.4.2
+        uses: pypa/gh-action-pypi-publish@v1.10.3
         with:
           user: __token__
           password: ${{ secrets.TEST_PYPI_TOKEN }}

.github/workflows/release-please.yml

@@ -0,0 +1,13 @@
+on:
+  push:
+    branches:
+      - main
+name: release-please
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: google-github-actions/release-please-action@v4
+        with:
+          token: ${{ secrets.THIS_PAT }}
+          release-type: python

.github/workflows/release.yml

@@ -8,33 +8,27 @@ jobs:
   release:
     name: Release
     runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/healthchecks-io
+    permissions:
+      id-token: write
     steps:
       - name: Check out the repository
-        uses: actions/checkout@v2.4.0
+        uses: actions/checkout@v4.1.4
         with:
           fetch-depth: 2
-
       - name: Set up Python
-        uses: actions/setup-python@v2.3.1
+        uses: actions/setup-python@v5.3.0
         with:
-          python-version: "3.10"
-
-      - name: Upgrade pip
+          python-version: "3.11"
+      - name: Install pip and poetry
         run: |
-          pip install --constraint=.github/workflows/constraints.txt pip
+          pip install --upgrade --constraint .github/workflows/constraints.txt pip poetry
           pip --version
-
-      - name: Install Poetry
-        run: |
-          pip install --constraint=.github/workflows/constraints.txt poetry poetry-dynamic-versioning
           poetry --version
-
       - name: Build package
         run: |
-          poetry build --ansi
-
-      - name: Publish package on PyPI
-        uses: pypa/gh-action-pypi-publish@v1.4.2
-        with:
-          user: __token__
-          password: ${{ secrets.PYPI_TOKEN }}
+          poetry build
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/tests.yml

@@ -2,7 +2,6 @@ name: Tests
 
 on:
   - push
-  - pull_request
 
 jobs:
   tests:
@@ -12,21 +11,15 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - { python: "3.10", os: "ubuntu-latest", session: "pre-commit" }
-          - { python: "3.10", os: "ubuntu-latest", session: "safety" }
-          - { python: "3.10", os: "ubuntu-latest", session: "mypy" }
-          - { python: "3.9", os: "ubuntu-latest", session: "mypy" }
-          - { python: "3.8", os: "ubuntu-latest", session: "mypy" }
-          - { python: "3.7", os: "ubuntu-latest", session: "mypy" }
+          - { python: "3.11", os: "ubuntu-latest", session: "pre-commit" }
+          - { python: "3.11", os: "ubuntu-latest", session: "safety" }
+          - { python: "3.12", os: "ubuntu-latest", session: "tests" }
+          - { python: "3.11", os: "ubuntu-latest", session: "tests" }
           - { python: "3.10", os: "ubuntu-latest", session: "tests" }
           - { python: "3.9", os: "ubuntu-latest", session: "tests" }
           - { python: "3.8", os: "ubuntu-latest", session: "tests" }
-          - { python: "3.7", os: "ubuntu-latest", session: "tests" }
-          - { python: "3.10", os: "windows-latest", session: "tests" }
-          - { python: "3.10", os: "macos-latest", session: "tests" }
-          # - { python: "3.10", os: "ubuntu-latest", session: "typeguard" }
-          - { python: "3.10", os: "ubuntu-latest", session: "xdoctest" }
-          - { python: "3.10", os: "ubuntu-latest", session: "docs-build" }
+          - { python: "3.11", os: "ubuntu-latest", session: "xdoctest" }
+          - { python: "3.11", os: "ubuntu-latest", session: "docs-build" }
 
     env:
       NOXSESSION: ${{ matrix.session }}
@@ -35,37 +28,19 @@ jobs:
 
     steps:
       - name: Check out the repository
-        uses: actions/checkout@v2.4.0
+        uses: actions/checkout@v4
 
       - name: Set up Python ${{ matrix.python }}
-        uses: actions/setup-python@v2.3.1
+        uses: actions/setup-python@v5.3.0
         with:
           python-version: ${{ matrix.python }}
 
-      - name: Upgrade pip
+      - name: Install needed tools
         run: |
-          pip install --constraint=.github/workflows/constraints.txt pip
+          pip install --upgrade pip nox poetry virtualenv toml --constraint=.github/workflows/constraints.txt
           pip --version
-
-      - name: Upgrade pip in virtual environments
-        shell: python
-        run: |
-          import os
-          import pip
-
-          with open(os.environ["GITHUB_ENV"], mode="a") as io:
-              print(f"VIRTUALENV_PIP={pip.__version__}", file=io)
-
-      - name: Install Poetry
-        run: |
-          pipx install --pip-args=--constraint=.github/workflows/constraints.txt poetry
-          poetry --version
-
-      - name: Install Nox
-        run: |
-          pipx install --pip-args=--constraint=.github/workflows/constraints.txt nox
-          pipx inject --pip-args=--constraint=.github/workflows/constraints.txt nox nox-poetry
-          nox --version
+          # separate out nox-poetry until it gets a released version with support for 1.8
+          pip install --upgrade nox-poetry --constraint=.github/workflows/constraints.txt
 
       - name: Compute pre-commit cache key
         if: matrix.session == 'pre-commit'
@@ -74,16 +49,18 @@ jobs:
         run: |
           import hashlib
           import sys
+          import os
 
           python = "py{}.{}".format(*sys.version_info[:2])
           payload = sys.version.encode() + sys.executable.encode()
           digest = hashlib.sha256(payload).hexdigest()
           result = "${{ runner.os }}-{}-{}-pre-commit".format(python, digest[:8])
 
-          print("::set-output name=result::{}".format(result))
+          with open(os.environ['GITHUB_OUTPUT'], 'a') as fh:
+            fh.write(f"result={result}\n")
 
       - name: Restore pre-commit cache
-        uses: actions/cache@v2.1.7
+        uses: actions/cache@v4.1.2
         if: matrix.session == 'pre-commit'
         with:
           path: ~/.cache/pre-commit
@@ -94,61 +71,3 @@ jobs:
       - name: Run Nox
         run: |
           nox --force-color --python=${{ matrix.python }}
-
-      - name: Upload coverage data
-        if: always() && matrix.session == 'tests'
-        uses: "actions/upload-artifact@v2.3.1"
-        with:
-          name: coverage-data
-          path: ".coverage.*"
-
-      - name: Upload documentation
-        if: matrix.session == 'docs-build'
-        uses: actions/upload-artifact@v2.3.1
-        with:
-          name: docs
-          path: docs/_build
-
-  coverage:
-    runs-on: ubuntu-latest
-    needs: tests
-    steps:
-      - name: Check out the repository
-        uses: actions/checkout@v2.4.0
-
-      - name: Set up Python
-        uses: actions/setup-python@v2.3.1
-        with:
-          python-version: "3.10"
-
-      - name: Upgrade pip
-        run: |
-          pip install --constraint=.github/workflows/constraints.txt pip
-          pip --version
-
-      - name: Install Poetry
-        run: |
-          pipx install --pip-args=--constraint=.github/workflows/constraints.txt poetry
-          poetry --version
-
-      - name: Install Nox
-        run: |
-          pipx install --pip-args=--constraint=.github/workflows/constraints.txt nox
-          pipx inject --pip-args=--constraint=.github/workflows/constraints.txt nox nox-poetry
-          nox --version
-
-      - name: Download coverage data
-        uses: actions/download-artifact@v2.1.0
-        with:
-          name: coverage-data
-
-      - name: Combine coverage data and display human readable report
-        run: |
-          nox --force-color --session=coverage
-
-      - name: Create coverage report
-        run: |
-          nox --force-color --session=coverage -- xml
-
-      - name: Upload coverage report
-        uses: codecov/codecov-action@v2.1.0

.gitignore

@@ -8,3 +8,4 @@
 /docs/_build/
 /src/*.egg-info/
 __pycache__/
+.vscode

.pre-commit-config.yaml

@@ -1,12 +1,35 @@
+exclude: ".*tests\/fixtures.*"
 repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.4.3
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format
+  - repo: https://github.com/rhysd/actionlint
+    rev: v1.6.27
+    hooks:
+      - id: actionlint-docker
+        name: Actionlint
   - repo: local
     hooks:
-      - id: black
-        name: black
-        entry: black
+      - id: bandit
+        name: bandit
+        entry: bandit
         language: system
         types: [python]
         require_serial: true
+        args: ["-c", "pyproject.toml"]
       - id: check-added-large-files
         name: Check for added large files
         entry: check-added-large-files
@@ -27,33 +50,16 @@ repos:
         language: system
         types: [text]
         stages: [commit, push, manual]
-      - id: flake8
-        name: flake8
-        entry: flake8
-        language: system
-        types: [python]
-        exclude: "^(tests/*|noxfile.py)"
-        require_serial: true
       - id: pyupgrade
         name: pyupgrade
         description: Automatically upgrade syntax for newer versions.
         entry: pyupgrade
         language: system
         types: [python]
-        args: [--py37-plus]
-      - id: reorder-python-imports
-        name: Reorder python imports
-        entry: reorder-python-imports
-        language: system
-        types: [python]
-        args: [--application-directories=src]
+        args: [--py38-plus]
       - id: trailing-whitespace
         name: Trim Trailing Whitespace
         entry: trailing-whitespace-fixer
         language: system
         types: [text]
         stages: [commit, push, manual]
-  - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v2.5.1
-    hooks:
-      - id: prettier

.prettierignore

@@ -0,0 +1,2 @@
+.github/*
+CHANGELOG.md

.vscode/settings.json

@@ -1,3 +0,0 @@
-{
-  "python.pythonPath": "/home/andrew/.pyenv/versions/3.10.0/envs/healthchecks/bin/python"
-}

CHANGELOG.md

@@ -0,0 +1,60 @@
+# Changelog
+
+## [0.4.3](https://github.com/andrewthetechie/py-healthchecks.io/compare/v0.4.2...v0.4.3) (2024-07-03)
+
+
+### Dependencies
+
+* bump coverage from 7.5.1 to 7.5.2 ([#680](https://github.com/andrewthetechie/py-healthchecks.io/issues/680)) ([b372e66](https://github.com/andrewthetechie/py-healthchecks.io/commit/b372e66c44ae403af042a43b3d7de41142570eb3))
+* bump coverage from 7.5.2 to 7.5.3 ([#683](https://github.com/andrewthetechie/py-healthchecks.io/issues/683)) ([5325352](https://github.com/andrewthetechie/py-healthchecks.io/commit/5325352bae60b332f4602e37adb3f35cc8ae11c7))
+* bump httpx from 0.24.1 to 0.27.0 ([#668](https://github.com/andrewthetechie/py-healthchecks.io/issues/668)) ([6e88834](https://github.com/andrewthetechie/py-healthchecks.io/commit/6e88834d93ea28f9bfeb7b81bcac8227ee38580c))
+* bump pre-commit from 2.21.0 to 3.5.0 ([#669](https://github.com/andrewthetechie/py-healthchecks.io/issues/669)) ([4d00499](https://github.com/andrewthetechie/py-healthchecks.io/commit/4d00499f94c7e6ad4af86742996fca9c266e8ddf))
+* bump pytz from 2023.4 to 2024.1 ([#670](https://github.com/andrewthetechie/py-healthchecks.io/issues/670)) ([67ec0b5](https://github.com/andrewthetechie/py-healthchecks.io/commit/67ec0b5d58563c0fb92ee5a7754706b07d767c11))
+* bump reorder-python-imports from 3.12.0 to 3.13.0 ([#685](https://github.com/andrewthetechie/py-healthchecks.io/issues/685)) ([c071ced](https://github.com/andrewthetechie/py-healthchecks.io/commit/c071ced5bfc00fcfef922d01a3c70961f03176d6))
+* bump ruff from 0.4.3 to 0.4.4 ([#675](https://github.com/andrewthetechie/py-healthchecks.io/issues/675)) ([e46f70c](https://github.com/andrewthetechie/py-healthchecks.io/commit/e46f70c4708eb703c0f02a97efe62a94145f6e58))
+* bump ruff from 0.4.4 to 0.4.5 ([#679](https://github.com/andrewthetechie/py-healthchecks.io/issues/679)) ([55ea01d](https://github.com/andrewthetechie/py-healthchecks.io/commit/55ea01de63c43865c0b41b4248f02d96b17f1c07))
+* bump ruff from 0.4.5 to 0.4.6 ([#681](https://github.com/andrewthetechie/py-healthchecks.io/issues/681)) ([627f070](https://github.com/andrewthetechie/py-healthchecks.io/commit/627f070e3fcbaf53a523a5b81b0699e39ffc4229))
+* bump ruff from 0.4.6 to 0.5.0 ([#699](https://github.com/andrewthetechie/py-healthchecks.io/issues/699)) ([f9e0fd0](https://github.com/andrewthetechie/py-healthchecks.io/commit/f9e0fd0bd135621f031ed5d490cfabdd90c8991d))
+* bump the pip group with 3 updates ([#694](https://github.com/andrewthetechie/py-healthchecks.io/issues/694)) ([a4b7396](https://github.com/andrewthetechie/py-healthchecks.io/commit/a4b73966f1b44c609bd9bdd25505429bb8b772a8))
+* bump types-pytz from 2023.4.0.20240130 to 2024.1.0.20240417 ([#672](https://github.com/andrewthetechie/py-healthchecks.io/issues/672)) ([e24fcb2](https://github.com/andrewthetechie/py-healthchecks.io/commit/e24fcb233bd7a35f3999e9fb7bd174ef357ecdcb))
+
+## [0.4.2](https://github.com/andrewthetechie/py-healthchecks.io/compare/v0.4.1...v0.4.2) (2024-05-07)
+
+
+### Dependencies
+
+* bump croniter from 1.4.1 to 2.0.5 ([#660](https://github.com/andrewthetechie/py-healthchecks.io/issues/660)) ([f945389](https://github.com/andrewthetechie/py-healthchecks.io/commit/f94538951c0aed4b0528974d6cb29c4cfd859845))
+* bump pytest-cov from 4.1.0 to 5.0.0 ([#663](https://github.com/andrewthetechie/py-healthchecks.io/issues/663)) ([802520d](https://github.com/andrewthetechie/py-healthchecks.io/commit/802520d4548d70e5597321e02b8d11af322431bd))
+* bump safety from 2.3.5 to 3.2.0 ([#661](https://github.com/andrewthetechie/py-healthchecks.io/issues/661)) ([c56e048](https://github.com/andrewthetechie/py-healthchecks.io/commit/c56e048635d32eb9cf5c4f82a9929e9065da5735))
+* bump sphinx from 5.3.0 to 7.1.2 ([#662](https://github.com/andrewthetechie/py-healthchecks.io/issues/662)) ([97723e9](https://github.com/andrewthetechie/py-healthchecks.io/commit/97723e91b631e3c4266a090e169eb19ffe1de153))
+
+
+### Documentation
+
+* bump furo from 2024.4.27 to 2024.5.6 in /docs ([#665](https://github.com/andrewthetechie/py-healthchecks.io/issues/665)) ([b7438af](https://github.com/andrewthetechie/py-healthchecks.io/commit/b7438af1275ce8fceb5d996aabd28cce5ca1193c))
+
+## [0.4.1](https://github.com/andrewthetechie/py-healthchecks.io/compare/v0.4.0...v0.4.1) (2024-05-05)
+
+
+### Bug Fixes
+
+* update poetry and virtualenv ([#489](https://github.com/andrewthetechie/py-healthchecks.io/issues/489)) ([1376595](https://github.com/andrewthetechie/py-healthchecks.io/commit/1376595877577848e0672d88403dc5740e7c1664))
+
+
+### Dependencies
+
+* bump pytest-asyncio from 0.21.2 to 0.23.6 ([#657](https://github.com/andrewthetechie/py-healthchecks.io/issues/657)) ([f785186](https://github.com/andrewthetechie/py-healthchecks.io/commit/f7851865821ed0f6df4d4977a4e3a5bc26bbf190))
+* bump ruff from 0.0.275 to 0.4.3 ([#655](https://github.com/andrewthetechie/py-healthchecks.io/issues/655)) ([6de87bb](https://github.com/andrewthetechie/py-healthchecks.io/commit/6de87bb43d2c236f1be762d439998baea5d0c417))
+* bump types-croniter from 1.4.0.1 to 2.0.0.20240423 ([#654](https://github.com/andrewthetechie/py-healthchecks.io/issues/654)) ([50f8bba](https://github.com/andrewthetechie/py-healthchecks.io/commit/50f8bbabb2df6aed0931ca5979792e694121650c))
+
+
+### Documentation
+
+* fixes get_check args ([#597](https://github.com/andrewthetechie/py-healthchecks.io/issues/597)) ([cb862fa](https://github.com/andrewthetechie/py-healthchecks.io/commit/cb862fa2c576b62dee2661a2939f69548726bc11))
+
+## [0.4.0](https://github.com/andrewthetechie/py-healthchecks.io/compare/v0.3.1...v0.4.0) (2023-02-21)
+
+
+### Features
+
+* add python 3.11 support ([#392](https://github.com/andrewthetechie/py-healthchecks.io/issues/392)) ([a752c42](https://github.com/andrewthetechie/py-healthchecks.io/commit/a752c42a28762fed48c3af57c7543b8b3b606702))

README.rst

@@ -7,16 +7,16 @@ Py Healthchecks.Io
 
 |pre-commit| |Black|
 
-.. |PyPI| image:: https://img.shields.io/pypi/v/py-healthchecksio.svg
-   :target: https://pypi.org/project/py-healthchecksio/
+.. |PyPI| image:: https://img.shields.io/pypi/v/healthchecks-io.svg
+   :target: https://pypi.org/project/healthchecks-io/
    :alt: PyPI
-.. |Status| image:: https://img.shields.io/pypi/status/py-healthchecksio.svg
-   :target: https://pypi.org/project/py-healthchecksio/
+.. |Status| image:: https://img.shields.io/pypi/status/healthchecks-io.svg
+   :target: https://pypi.org/project/healthchecks-io/
    :alt: Status
-.. |Python Version| image:: https://img.shields.io/pypi/pyversions/py-healthchecksio
-   :target: https://pypi.org/project/py-healthchecksio
+.. |Python Version| image:: https://img.shields.io/pypi/pyversions/healthchecks-io
+   :target: https://pypi.org/project/healthchecks-io
    :alt: Python Version
-.. |License| image:: https://img.shields.io/pypi/l/py-healthchecks.io
+.. |License| image:: https://img.shields.io/pypi/l/healthchecks-io
    :target: https://opensource.org/licenses/MIT
    :alt: License
 .. |Read the Docs| image:: https://img.shields.io/readthedocs/py-healthchecksio/latest.svg?label=Read%20the%20Docs

bandit.yml

@@ -0,0 +1,3 @@
+exclude_dirs: ["test", "examples"]
+assert_used:
+  skips: ["*/test_*.py", "noxfile.py"]

docs/conf.py

@@ -1,4 +1,5 @@
 """Sphinx configuration."""
+
 from datetime import datetime
 
 
@@ -8,7 +9,6 @@ copyright = f"{datetime.now().year}, {author}"
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
-    "sphinx_click",
 ]
 autodoc_typehints = "description"
 html_theme = "furo"

docs/requirements.txt

@@ -1,3 +1,2 @@
-furo==2021.11.23
-sphinx==4.3.1
-sphinx-click==3.0.2
+furo==2024.8.6
+sphinx==8.1.3

docs/usage.rst

@@ -3,6 +3,31 @@ Usage
 
 This package implements the Healthchecks.io Management and Ping APIs as documented here https://healthchecks.io/docs/api/.
 
+Context Manager
+---------------
+
+Either the Client or AsyncClient can be used as a ContextManager (or Async Context Manager)
+
+.. code-block:: python
+
+    from healthchecks_io import Client, CheckCreate
+
+    with Client(api_key="myapikey") as client:
+        check = client.create_check(CheckCreate(name="New Check", tags="tag1 tag2"))
+    print(check)
+
+This is probably the easiest way to use the Clients for one-off scripts. If you do not need to keep a client open for multiple requests, just use
+the context manager.
+
+.. note::
+    When using either of the client types as a context manager, the httpx client underlying the client will be closed when the context manager exits.
+
+    Since we allow you to pass in a client on creation, its possible to use a shared client with this library. If you then use the client as a contextmanager,
+    it will close that shared client.
+
+    Just a thing to be aware of!
+
+
 Sync
 ----
 
@@ -38,7 +63,7 @@ Creating a new Check
 
     client = Client(api_key="myapikey")
 
-    check = client.create_check(CreateCheck(name="New Check", tags="tag1 tag2")
+    check = client.create_check(CheckCreate(name="New Check", tags="tag1 tag2"))
     print(check)
 
 Getting a Check
@@ -50,13 +75,14 @@ Getting a Check
 
     client = Client(api_key="myapikey")
 
-    check = client.get_check(uuid="mychecksuuid")
+    check = client.get_check(check_id="mychecksuuid")
     print(check)
 
 Pinging a Check
 ^^^^^^^^^^^^^^^
 
 .. code-block:: python
+
     from healthchecks_io import Client
 
     client = Client(api_key="myapikey")
@@ -68,13 +94,54 @@ Async
 
 If you want to use the client in an async program, use AsyncClient instead of Client
 
+.. code-block:: python
 
+    import asyncio
+    from healthchecks_io import AsyncClient, CheckCreate
+
+    async def main():
+        client = AsyncClient(api_key="myapikey")
+
+        check = await client.create_check(CheckCreate(name="New Check", tags="tag1 tag2"))
+        print(check)
+
+    if __name__ == "__main__":
+        asyncio.run(main())
+
+
+CheckTrap
+---------
+
+Ever wanted to run some code and wrape it in a healthcheck check without thinking about it?
+
+That's what CheckTrap is for.
 
 .. code-block:: python
 
-    from healthchecks_io import AsyncClient, CheckCreate
+    import asyncio
+    from healthchecks_io import Client, AsyncClient, CheckCreate, CheckTrap
 
-    client = AsyncClient(api_key="myapikey")
+    def run_my_thing_to_monitor():
+        pass
 
-    check = await client.create_check(CreateCheck(name="New Check", tags="tag1 tag2")
-    print(check)
+    async def main(check):
+        client = AsyncClient(ping_key="ping_key")
+
+        # works with async too, and the ping api and slugs
+        async with CheckTrap(client, slug=check.slug) as ct:
+            # when entering the context manager, sends a start ping to your check
+            # Add custom logs to what gets sent to healthchecks. Reminder, only the first 10k bytes get saved
+            ct.add_log("My custom log message")
+            run_my_thing_to_monitor()
+
+    if __name__ == "__main__":
+        client = Client(api_key="myapikey")
+
+        # create a new check, or use an existing one already with just its uuid.
+        check = await client.create_check(CreateCheck(name="New Check", tags="tag1 tag2")
+
+        with CheckTrap(client, check.uuid):
+            # when entering the context manager, sends a start ping to your check
+            run_my_thing_to_monitor()
+
+        asyncio.run(main())

noxfile.py

@@ -1,4 +1,5 @@
 """Nox sessions."""
+
 import os
 import shlex
 import shutil
@@ -7,6 +8,7 @@ from pathlib import Path
 from textwrap import dedent
 
 import nox
+import toml
 
 try:
     from nox_poetry import Session
@@ -22,27 +24,19 @@ except ImportError:
 
 
 package = "healthchecks_io"
-python_versions = ["3.10", "3.9", "3.8", "3.7"]
+python_versions = ["3.11", "3.12", "3.10", "3.9", "3.8"]
 nox.needs_version = ">= 2021.6.6"
 nox.options.sessions = (
     "pre-commit",
-    "bandit",
     "safety",
-    "mypy",
+    # "mypy",
     "tests",
-    # "typeguard",
     "xdoctest",
     "docs-build",
 )
-mypy_type_packages = ("types-croniter", "types-pytz")
-test_requirements = (
-    "coverage[toml]",
-    "pytest",
-    "pygments",
-    "respx",
-    "pytest-asyncio",
-    "pytest-lazy-fixture",
-)
+
+pyproject = toml.load("pyproject.toml")
+test_requirements = pyproject["tool"]["poetry"]["group"]["dev"]["dependencies"].keys()
 
 
 def activate_virtualenv_in_precommit_hooks(session: Session) -> None:
@@ -61,8 +55,7 @@ def activate_virtualenv_in_precommit_hooks(session: Session) -> None:
     # quoting rules for Python and bash, but strip the outermost quotes so we
     # can detect paths within the bindir, like <bindir>/python.
     bindirs = [
-        bindir[1:-1] if bindir[0] in "'\"" else bindir
-        for bindir in (repr(session.bin), shlex.quote(session.bin))
+        bindir[1:-1] if bindir[0] in "'\"" else bindir for bindir in (repr(session.bin), shlex.quote(session.bin))
     ]
 
     virtualenv = session.env.get("VIRTUAL_ENV")
@@ -99,10 +92,7 @@ def activate_virtualenv_in_precommit_hooks(session: Session) -> None:
 
         text = hook.read_text()
 
-        if not any(
-            Path("A") == Path("a") and bindir.lower() in text.lower() or bindir in text
-            for bindir in bindirs
-        ):
+        if not any(Path("A") == Path("a") and bindir.lower() in text.lower() or bindir in text for bindir in bindirs):
             continue
 
         lines = text.splitlines()
@@ -118,20 +108,7 @@ def activate_virtualenv_in_precommit_hooks(session: Session) -> None:
 def precommit(session: Session) -> None:
     """Lint using pre-commit."""
     args = session.posargs or ["run", "--all-files", "--show-diff-on-failure"]
-    session.install(
-        "black",
-        "darglint",
-        "flake8",
-        "flake8-bandit",
-        "flake8-bugbear",
-        "flake8-docstrings",
-        "flake8-rst-docstrings",
-        "pep8-naming",
-        "pre-commit",
-        "pre-commit-hooks",
-        "pyupgrade",
-        "reorder-python-imports",
-    )
+    session.install(*test_requirements)
     session.run("pre-commit", *args)
     if args and args[0] == "install":
         activate_virtualenv_in_precommit_hooks(session)
@@ -142,7 +119,13 @@ def safety(session: Session) -> None:
     """Scan dependencies for insecure packages."""
     requirements = session.poetry.export_requirements()
     session.install("safety")
-    session.run("safety", "check", "--full-report", f"--file={requirements}")
+    # ignore https://github.com/pytest-dev/py/issues/287
+    # its an irresposnbily filed CVE causing nose
+    # ignore https://data.safetycli.com/v/70612/97c/
+    # Jinja2 vulnerability, maintainer believe it is not a valid vulnerability
+    # ignore https://data.safetycli.com/v/71064/97c/
+    # requests vulnerability. The fixed version is not compatible with the packaging library
+    session.run("safety", "check", "--full-report", f"--file={requirements}", "--ignore=51457,70612,71064")
 
 
 @session(python=python_versions)
@@ -151,48 +134,16 @@ def mypy(session: Session) -> None:
     args = session.posargs or ["src"]
     session.install(".")
     session.install("mypy", "pytest")
-    session.install(*mypy_type_packages)
+    session.install(*test_requirements)
     session.run("mypy", *args)
 
 
-@session(python=python_versions[0])
-def bandit(session: Session) -> None:
-    """Run bandit security tests"""
-    args = session.posargs or ["-r", "./src"]
-    session.run("bandit", *args)
-
-
 @session(python=python_versions)
 def tests(session: Session) -> None:
     """Run the test suite."""
     session.install(".")
     session.install(*test_requirements)
-    try:
-        session.run("coverage", "run", "--parallel", "-m", "pytest", *session.posargs)
-    finally:
-        if session.interactive:
-            session.notify("coverage", posargs=[])
-
-
-@session(python=python_versions[0])
-def coverage(session: Session) -> None:
-    """Produce the coverage report."""
-    args = session.posargs or ["report"]
-
-    session.install("coverage[toml]")
-
-    if not session.posargs and any(Path().glob(".coverage.*")):
-        session.run("coverage", "combine")
-
-    session.run("coverage", *args)
-
-
-@session(python=python_versions)
-def typeguard(session: Session) -> None:
-    """Runtime type checking using Typeguard."""
-    session.install(".")
-    session.install("pytest", "typeguard", "pygments")
-    session.run("pytest", f"--typeguard-packages={package}", *session.posargs)
+    session.run("poetry", "run", "pytest", *session.posargs)
 
 
 @session(python=python_versions)

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "healthchecks_io"
-version = "0.0.0"
+version = "0.4.3"
 description = "A python client package for Healthchecks.io API"
 authors = ["Andrew Herrington <andrew.the.techie@gmail.com>"]
 license = "MIT"
@@ -9,52 +9,52 @@ homepage = "https://github.com/andrewthetechie/py-healthchecks.io"
 repository = "https://github.com/andrewthetechie/py-healthchecks.io"
 documentation = "https://py-healthchecks.io.readthedocs.io"
 classifiers = [
-    "Development Status :: 3 - Alpha",
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+	"License :: OSI Approved :: MIT License",
+	"Programming Language :: Python",
+	"Programming Language :: Python :: 3",
+	"Programming Language :: Python :: 3.7",
+	"Programming Language :: Python :: 3.8",
+	"Programming Language :: Python :: 3.9",
+	"Programming Language :: Python :: 3.10",
+	"Framework :: AsyncIO"
 ]
 
 [tool.poetry.urls]
 Changelog = "https://github.com/andrewthetechie/py-healthchecks.io/releases"
 
 [tool.poetry.dependencies]
-python = "^3.7"
-click = "^8.0.1"
-pydantic = "^1.8.2"
-httpx = "^0.21.1"
-croniter = "^1.1.0"
-pytz = "^2021.3"
+python = "^3.8"
+pydantic = ">=1.9.1,<3.0.0"
+httpx = ">=0.23.0,<0.28.0"
+croniter = ">=1.1,<4.0"
+pytz = ">=2024.1,<2025.0"
+packaging = "^24.1"
 
-[tool.poetry.dev-dependencies]
-pytest = "^6.2.5"
-coverage = {extras = ["toml"], version = "^6.2"}
-safety = "^1.10.3"
-mypy = "^0.910"
-typeguard = "^2.13.2"
-xdoctest = {extras = ["colors"], version = "^0.15.10"}
-sphinx = "^4.3.1"
+[tool.poetry.group.dev.dependencies]
+pytest = ">=7.2.1,<9.0.0"
+coverage = {extras = ["toml"], version = "^7.1"}
+safety = ">=2.3.5,<4.0.0"
+mypy = "^1.0"
+xdoctest = {extras = ["colors"], version = "^1.1.1"}
+sphinx = ">=4.3.2,<8.0.0"
 sphinx-autobuild = ">=2021.3.14"
-pre-commit = "^2.16.0"
-flake8 = "^4.0.1"
-black = ">=21.10b0"
-flake8-bandit = "^2.1.2"
-flake8-bugbear = ">=21.9.2"
-flake8-docstrings = "^1.6.0"
-flake8-rst-docstrings = "^0.2.3"
-pep8-naming = "^0.12.1"
-darglint = "^1.8.1"
-reorder-python-imports = "^2.6.0"
-pre-commit-hooks = "^4.0.1"
-sphinx-click = "^3.0.2"
-Pygments = "^2.10.0"
-pyupgrade = "^2.29.1"
+pre-commit = ">=2.21,<4.0"
+reorder-python-imports = "^3.9.0"
+pre-commit-hooks = "^4.4.0"
+pyupgrade = "^3.3.1"
 furo = ">=2021.11.12"
-pytest-cov = "^3.0.0"
-types-croniter = "^1.0.3"
-types-pytz = "^2021.3.3"
-pytest_async = "^0.1.1"
-pytest-asyncio = "^0.16.0"
-respx = "^0.19.0"
-pytest-mock = "^3.6.1"
+pytest-cov = ">=4,<6"
+types-croniter = ">=1.3.2,<4.0.0"
+types-pytz = ">=2022.7.1,<2025.0.0"
+pytest-asyncio = ">=0.20.3,<0.24.0"
+respx = ">=0.20.1,<0.22.0"
+pytest-mock = "^3.10.0"
 pytest-lazy-fixture = "^0.6.3"
+pytest-xdist = "^3.2.0"
+ruff = ">=0.5.1,<0.6.9"
+bandit = "^1.7.4"
 
 [tool.coverage.paths]
 source = ["src", "*/site-packages"]
@@ -68,6 +68,9 @@ source = ["healthchecks_io"]
 show_missing = true
 fail_under = 100
 
+[tool.bandit]
+exclude_dirs = ["tests", "noxfile.py", ".github/scripts", "test_errbot", "dist"]
+
 [tool.mypy]
 strict = true
 warn_unreachable = true
@@ -77,13 +80,12 @@ show_error_codes = true
 show_error_context = true
 
 [build-system]
-requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning"]
+requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
 
-[tool.poetry-dynamic-versioning]
-enable = true
-vcs = "git"
-dirty = true
+[tool.pytest.ini_options]
+addopts = "-n 4 --ignore examples --cov=healthchecks_io --cov-report xml:.coverage.xml --cov-report=term-missing --cov-fail-under 91"
 
-[tool.poetry-dynamic-versioning.substitution]
-files = ["src/healthchecks_io/__init__.py"]
+[tool.ruff]
+line-length = 120
+target-version = "py38"

src/healthchecks_io/__init__.py

@@ -1,21 +1,26 @@
 """Py Healthchecks.Io."""
+
 # set by poetry-dynamic-versioning
-__version__ = "0.0.0"  # noqa: E402
+__version__ = "0.4.3"  # noqa: E402
 
 from .client import AsyncClient  # noqa: F401, E402
 from .client import Client  # noqa: F401, E402
+from .client import CheckTrap  # noqa: F401, E402
 from .client.exceptions import BadAPIRequestError  # noqa: F401, E402
 from .client.exceptions import CheckNotFoundError  # noqa: F401, E402
 from .client.exceptions import HCAPIAuthError  # noqa: F401, E402
 from .client.exceptions import HCAPIError  # noqa: F401, E402
 from .client.exceptions import HCAPIRateLimitError  # noqa: F401, E402
 from .client.exceptions import NonUniqueSlugError  # noqa: F401, E402
+from .client.exceptions import WrongClientError  # noqa: F401, E402
+from .client.exceptions import PingFailedError  # noqa: F401, E402
 from .schemas import Check, CheckCreate, CheckPings, CheckStatuses  # noqa: F401, E402
 from .schemas import Integration, Badges, CheckUpdate  # noqa: F401, E402
 
 __all__ = [
     "AsyncClient",
     "Client",
+    "CheckTrap",
     "BadAPIRequestError",
     "CheckNotFoundError",
     "HCAPIAuthError",
@@ -23,6 +28,8 @@ __all__ = [
     "CheckNotFoundError",
     "HCAPIRateLimitError",
     "NonUniqueSlugError",
+    "WrongClientError",
+    "PingFailedError",
     "Check",
     "CheckCreate",
     "CheckUpdate",

src/healthchecks_io/client/__init__.py

@@ -1,5 +1,7 @@
 """healthchecks_io clients."""
+
 from .async_client import AsyncClient  # noqa: F401
+from .check_trap import CheckTrap  # noqa: F401
 from .sync_client import Client  # noqa: F401
 
-__all__ = ["AsyncClient", "Client"]
+__all__ = ["AsyncClient", "Client", "CheckTrap"]

src/healthchecks_io/client/_abstract.py

@@ -57,9 +57,7 @@ class AbstractClient(ABC):
         """Finalizer method is called by weakref.finalize when the object is dereferenced to do cleanup of clients."""
         pass
 
-    def _get_api_request_url(
-        self, path: str, params: Optional[Dict[str, Any]] = None
-    ) -> str:
+    def _get_api_request_url(self, path: str, params: Optional[Dict[str, Any]] = None) -> str:
         """Get a full request url for the healthchecks api.
 
         Args:
@@ -83,7 +81,8 @@ class AbstractClient(ABC):
             endpoint (str): Endpoint to request
 
         Raises:
-            BadAPIRequestError: Raised if you pass a uuid and a slug, or if pinging by a slug and do not have a ping key set
+            BadAPIRequestError: Raised if you pass a uuid and a slug, or if pinging by a slug and do not have a
+            ping key set
 
         Returns:
             str: url for this
@@ -164,9 +163,7 @@ class AbstractClient(ABC):
             raise CheckNotFoundError(f"CHeck not found at {response.request.url}")
 
         if response.status_code == 400:
-            raise BadAPIRequestError(
-                f"Bad request when requesting {response.request.url}. {response.text}"
-            )
+            raise BadAPIRequestError(f"Bad request when requesting {response.request.url}. {response.text}")
 
         return response
 
@@ -207,21 +204,15 @@ class AbstractClient(ABC):
             raise HCAPIRateLimitError(f"Rate limited on {response.request.url}")
 
         if response.status_code == 400:
-            raise BadAPIRequestError(
-                f"Bad request when requesting {response.request.url}. {response.text}"
-            )
+            raise BadAPIRequestError(f"Bad request when requesting {response.request.url}. {response.text}")
 
         if response.status_code == 409:
-            raise NonUniqueSlugError(
-                f"Bad request, slug conflict {response.request.url}. {response.text}"
-            )
+            raise NonUniqueSlugError(f"Bad request, slug conflict {response.request.url}. {response.text}")
 
         return response
 
     @staticmethod
-    def _add_url_params(
-        url: str, params: Dict[str, Union[str, int, bool]], replace: bool = True
-    ) -> str:
+    def _add_url_params(url: str, params: Dict[str, Union[str, int, bool]], replace: bool = True) -> str:
         """Add GET params to provided URL being aware of existing.
 
         :param url: string of target URL
@@ -254,12 +245,7 @@ class AbstractClient(ABC):
             # get all the duplicated keys from params and urlencode them, we'll concat this to the params string later
             duplicated_params = [x for x in params if x in parsed_get_args]
             # get all the args that aren't duplicated and add them to parsed_get_args
-            parsed_get_args.update(
-                {
-                    key: parsed_params[key]
-                    for key in [x for x in params if x not in parsed_get_args]
-                }
-            )
+            parsed_get_args.update({key: parsed_params[key] for key in [x for x in params if x not in parsed_get_args]})
             # if we have any duplicated parameters, urlencode them, we append them later
             extra_parameters = (
                 f"&{urlencode({key: params[key] for key in duplicated_params}, doseq=True)}"

src/healthchecks_io/client/async_client.py

@@ -1,9 +1,12 @@
 """An async healthchecks.io client."""
+
 import asyncio
+from types import TracebackType
 from typing import Dict
 from typing import List
 from typing import Optional
 from typing import Tuple
+from typing import Type
 
 from httpx import AsyncClient as HTTPXAsyncClient
 
@@ -40,9 +43,7 @@ class AsyncClient(AbstractClient):
             client (Optional[HTTPXAsyncClient], optional): A httpx.Asyncclient. If not
                 passed in, one will be created for this object. Defaults to None.
         """
-        self._client: HTTPXAsyncClient = (
-            HTTPXAsyncClient() if client is None else client
-        )
+        self._client: HTTPXAsyncClient = HTTPXAsyncClient() if client is None else client
         super().__init__(
             api_key=api_key,
             ping_key=ping_key,
@@ -51,11 +52,26 @@ class AsyncClient(AbstractClient):
             api_version=api_version,
         )
         self._client.headers["X-Api-Key"] = self._api_key
-        self._client.headers[
-            "user-agent"
-        ] = f"py-healthchecks.io-async/{client_version}"
+        self._client.headers["user-agent"] = f"py-healthchecks.io-async/{client_version}"
         self._client.headers["Content-type"] = "application/json"
 
+    async def __aenter__(self) -> "AsyncClient":
+        """Context manager entrance.
+
+        Returns:
+            AsyncClient: returns this client as a context manager
+        """
+        return self
+
+    async def __aexit__(
+        self,
+        exc_type: Optional[Type[BaseException]],
+        exc: Optional[BaseException],
+        traceback: Optional[TracebackType],
+    ) -> None:
+        """Context manager exit."""
+        await self._afinalizer_method()
+
     def _finalizer_method(self) -> None:
         """Calls _afinalizer_method from a sync context to work with weakref.finalizer."""
         asyncio.run(self._afinalizer_method())
@@ -78,9 +94,7 @@ class AsyncClient(AbstractClient):
             Check: check that was just created
         """
         request_url = self._get_api_request_url("checks/")
-        response = self.check_response(
-            await self._client.post(request_url, json=new_check.dict())
-        )
+        response = self.check_response(await self._client.post(request_url, json=new_check.dict(exclude_none=True)))
         return Check.from_api_result(response.json())
 
     async def update_check(self, uuid: str, update_check: CheckCreate) -> Check:
@@ -99,7 +113,8 @@ class AsyncClient(AbstractClient):
         request_url = self._get_api_request_url(f"checks/{uuid}")
         response = self.check_response(
             await self._client.post(
-                request_url, json=update_check.dict(exclude_unset=True)
+                request_url,
+                json=update_check.dict(exclude_unset=True, exclude_none=True),
             )
         )
         return Check.from_api_result(response.json())
@@ -123,16 +138,11 @@ class AsyncClient(AbstractClient):
         request_url = self._get_api_request_url("checks/")
         if tags is not None:
             for tag in tags:
-                request_url = self._add_url_params(
-                    request_url, {"tag": tag}, replace=False
-                )
+                request_url = self._add_url_params(request_url, {"tag": tag}, replace=False)
 
         response = self.check_response(await self._client.get(request_url))
 
-        return [
-            Check.from_api_result(check_data)
-            for check_data in response.json()["checks"]
-        ]
+        return [Check.from_api_result(check_data) for check_data in response.json()["checks"]]
 
     async def get_check(self, check_id: str) -> Check:
         """Get a single check by id.
@@ -227,10 +237,7 @@ class AsyncClient(AbstractClient):
         """
         request_url = self._get_api_request_url(f"checks/{check_id}/pings/")
         response = self.check_response(await self._client.get(request_url))
-        return [
-            CheckPings.from_api_result(check_data)
-            for check_data in response.json()["pings"]
-        ]
+        return [CheckPings.from_api_result(check_data) for check_data in response.json()["pings"]]
 
     async def get_check_flips(
         self,
@@ -254,8 +261,10 @@ class AsyncClient(AbstractClient):
         Args:
             check_id (str): check uuid
             seconds (Optional[int], optional): Returns the flips from the last value seconds. Defaults to None.
-            start (Optional[int], optional): Returns flips that are newer than the specified UNIX timestamp.. Defaults to None.
-            end (Optional[int], optional): Returns flips that are older than the specified UNIX timestamp.. Defaults to None.
+            start (Optional[int], optional): Returns flips that are newer than the specified UNIX timestamp.
+                Defaults to None.
+            end (Optional[int], optional): Returns flips that are older than the specified UNIX timestamp.
+                Defaults to None.
 
         Returns:
             List[CheckStatuses]: List of status flips for this check
@@ -287,10 +296,7 @@ class AsyncClient(AbstractClient):
         """
         request_url = self._get_api_request_url("channels/")
         response = self.check_response(await self._client.get(request_url))
-        return [
-            Integration.from_api_result(integration_dict)
-            for integration_dict in response.json()["channels"]
-        ]
+        return [Integration.from_api_result(integration_dict) for integration_dict in response.json()["channels"]]
 
     async def get_badges(self) -> Dict[str, Badges]:
         """Returns a dict of all tags in the project, with badge URLs for each tag.
@@ -301,7 +307,8 @@ class AsyncClient(AbstractClient):
         shields: returns JSON in a Shields.io compatible format.
         In addition, badges have 2-state and 3-state variations:
 
-        svg, json, shields: reports two states: "up" and "down". It considers any checks in the grace period as still "up".
+        svg, json, shields: reports two states: "up" and "down". It considers any checks in the grace period
+        as still "up".
         svg3, json3, shields3: reports three states: "up", "late", and "down".
 
         The response includes a special * entry: this pseudo-tag reports the overal status
@@ -317,12 +324,9 @@ class AsyncClient(AbstractClient):
         """
         request_url = self._get_api_request_url("badges/")
         response = self.check_response(await self._client.get(request_url))
-        return {
-            key: Badges.from_api_result(item)
-            for key, item in response.json()["badges"].items()
-        }
+        return {key: Badges.from_api_result(item) for key, item in response.json()["badges"].items()}
 
-    async def success_ping(self, uuid: str = "", slug: str = "") -> Tuple[bool, str]:
+    async def success_ping(self, uuid: str = "", slug: str = "", data: str = "") -> Tuple[bool, str]:
         """Signals to Healthchecks.io that a job has completed successfully.
 
         Can also be used to indicate a continuously running process is still running and healthy.
@@ -338,6 +342,7 @@ class AsyncClient(AbstractClient):
         Args:
             uuid (str): Check's UUID. Defaults to "".
             slug (str):  Check's Slug. Defaults to "".
+            data (str): Text data to append to this check. Defaults to "".
 
         Raises:
             HCAPIAuthError: Raised when status_code == 401 or 403
@@ -352,10 +357,10 @@ class AsyncClient(AbstractClient):
             Tuple[bool, str]: success (true or false) and the response text
         """
         ping_url = self._get_ping_url(uuid, slug, "")
-        response = self.check_ping_response(await self._client.get(ping_url))
+        response = self.check_ping_response(await self._client.post(ping_url, content=data))
         return (True if response.status_code == 200 else False, response.text)
 
-    async def start_ping(self, uuid: str = "", slug: str = "") -> Tuple[bool, str]:
+    async def start_ping(self, uuid: str = "", slug: str = "", data: str = "") -> Tuple[bool, str]:
         """Sends a "job has started!" message to Healthchecks.io.
 
         Sending a "start" signal is optional, but it enables a few extra features:
@@ -373,6 +378,7 @@ class AsyncClient(AbstractClient):
         Args:
             uuid (str): Check's UUID. Defaults to "".
             slug (str): Check's Slug. Defaults to "".
+            data (str): Text data to append to this check. Defaults to "".
 
         Raises:
             HCAPIAuthError: Raised when status_code == 401 or 403
@@ -387,10 +393,10 @@ class AsyncClient(AbstractClient):
             Tuple[bool, str]: success (true or false) and the response text
         """
         ping_url = self._get_ping_url(uuid, slug, "/start")
-        response = self.check_ping_response(await self._client.get(ping_url))
+        response = self.check_ping_response(await self._client.post(ping_url, content=data))
         return (True if response.status_code == 200 else False, response.text)
 
-    async def fail_ping(self, uuid: str = "", slug: str = "") -> Tuple[bool, str]:
+    async def fail_ping(self, uuid: str = "", slug: str = "", data: str = "") -> Tuple[bool, str]:
         """Signals to Healthchecks.io that the job has failed.
 
         Actively signaling a failure minimizes the delay from your monitored service failing to you receiving an alert.
@@ -406,6 +412,7 @@ class AsyncClient(AbstractClient):
         Args:
             uuid (str): Check's UUID. Defaults to "".
             slug (str): Check's Slug. Defaults to "".
+            data (str): Text data to append to this check. Defaults to "".
 
         Raises:
             HCAPIAuthError: Raised when status_code == 401 or 403
@@ -420,12 +427,10 @@ class AsyncClient(AbstractClient):
             Tuple[bool, str]: success (true or false) and the response text
         """
         ping_url = self._get_ping_url(uuid, slug, "/fail")
-        response = self.check_ping_response(await self._client.get(ping_url))
+        response = self.check_ping_response(await self._client.post(ping_url, content=data))
         return (True if response.status_code == 200 else False, response.text)
 
-    async def exit_code_ping(
-        self, exit_code: int, uuid: str = "", slug: str = ""
-    ) -> Tuple[bool, str]:
+    async def exit_code_ping(self, exit_code: int, uuid: str = "", slug: str = "", data: str = "") -> Tuple[bool, str]:
         """Signals to Healthchecks.io that the job has failed.
 
         Actively signaling a failure minimizes the delay from your monitored service failing to you receiving an alert.
@@ -442,6 +447,7 @@ class AsyncClient(AbstractClient):
             exit_code (int): Exit code to sent, int from 0 to 255
             uuid (str): Check's UUID. Defaults to "".
             slug (str): Check's Slug. Defaults to "".
+            data (str): Text data to append to this check. Defaults to "".
 
         Raises:
             HCAPIAuthError: Raised when status_code == 401 or 403
@@ -456,5 +462,5 @@ class AsyncClient(AbstractClient):
             Tuple[bool, str]: success (true or false) and the response text
         """
         ping_url = self._get_ping_url(uuid, slug, f"/{exit_code}")
-        response = self.check_ping_response(await self._client.get(ping_url))
+        response = self.check_ping_response(await self._client.post(ping_url, content=data))
         return (True if response.status_code == 200 else False, response.text)

src/healthchecks_io/client/check_trap.py

@@ -0,0 +1,161 @@
+"""CheckTrap is a context manager to wrap around python code to communicate results to a Healthchecks check."""
+
+from types import TracebackType
+from typing import List
+from typing import Optional
+from typing import Type
+from typing import Union
+
+from .async_client import AsyncClient
+from .exceptions import PingFailedError
+from .exceptions import WrongClientError
+from .sync_client import Client
+
+
+class CheckTrap:
+    """CheckTrap is a context manager to wrap around python code to communicate results to a Healthchecks check."""
+
+    def __init__(
+        self,
+        client: Union[Client, AsyncClient],
+        uuid: str = "",
+        slug: str = "",
+        suppress_exceptions: bool = False,
+    ) -> None:
+        """A context manager to wrap around python code to communicate results to a Healthchecks check.
+
+        Args:
+            client (Union[Client, AsyncClient]): healthchecks_io client, async or sync
+            uuid (str): uuid of the check. Defaults to "".
+            slug (str): slug of the check, exclusion wiht uuid. Defaults to "".
+            suppress_exceptions (bool): If true, do not raise any exceptions. Defaults to False.
+
+        Raises:
+            Exception: Raised if a slug and a uuid is passed
+        """
+        if uuid == "" and slug == "":
+            raise Exception("Must pass a slug or an uuid")
+        self.client: Union[Client, AsyncClient] = client
+        self.uuid: str = uuid
+        self.slug: str = slug
+        self.log_lines: List[str] = list()
+        self.suppress_exceptions: bool = suppress_exceptions
+
+    def add_log(self, line: str) -> None:
+        """Add a line to the context manager's log that is sent with the check.
+
+        Args:
+            line (str): String to add to the logs
+        """
+        self.log_lines.append(line)
+
+    def __enter__(self) -> "CheckTrap":
+        """Enter the context manager.
+
+        Sends a start ping to the check represented by self.uuid or self.slug.
+
+        Raises:
+            WrongClientError: Raised when using an AsyncClient with this as a sync client manager
+            PingFailedError: When a ping fails for any reason not handled by a custom exception
+            HCAPIAuthError: Raised when status_code == 401 or 403
+            HCAPIError: Raised when status_code is 5xx
+            CheckNotFoundError: Raised when status_code is 404 or response text has "not found" in it
+            BadAPIRequestError: Raised when status_code is 400, or if you pass a uuid and a slug, or if
+                pinging by a slug and do not have a ping key set
+            HCAPIRateLimitError: Raised when status code is 429 or response text has "rate limited" in it
+            NonUniqueSlugError: Raused when status code is 409.
+
+        Returns:
+            CheckTrap: self
+        """
+        if isinstance(self.client, AsyncClient):
+            raise WrongClientError("You passed an AsyncClient, use this as an async context manager")
+        result = self.client.start_ping(uuid=self.uuid, slug=self.slug)
+        if not result[0]:
+            raise PingFailedError(result[1])
+        return self
+
+    def __exit__(
+        self,
+        exc_type: Optional[Type[BaseException]],
+        exc: Optional[BaseException],
+        traceback: Optional[TracebackType],
+    ) -> Optional[bool]:
+        """Exit the context manager.
+
+        If there is an exception, add it to any log lines and send a fail ping.
+        Otherwise, send a success ping with any log lines appended.
+
+        Args:
+            exc_type (Optional[Type[BaseException]]): [description]
+            exc (Optional[BaseException]): [description]
+            traceback (Optional[TracebackType]): [description]
+
+        Returns:
+            Optional[bool]: self.suppress_exceptions, if true will not raise any exceptions
+        """
+        if exc_type is None:
+            self.client.success_ping(self.uuid, self.slug, data="\n".join(self.log_lines))
+        else:
+            self.add_log(str(exc))
+            self.add_log(str(traceback))
+            self.client.fail_ping(self.uuid, self.slug, data="\n".join(self.log_lines))
+        return self.suppress_exceptions
+
+    async def __aenter__(self) -> "CheckTrap":
+        """Enter the context manager.
+
+        Sends a start ping to the check represented by self.uuid or self.slug.
+
+        Raises:
+            WrongClientError: Raised when using an AsyncClient with this as a sync client manager
+            PingFailedError: When a ping fails for any reason not handled by a custom exception
+            HCAPIAuthError: Raised when status_code == 401 or 403
+            HCAPIError: Raised when status_code is 5xx
+            CheckNotFoundError: Raised when status_code is 404 or response text has "not found" in it
+            BadAPIRequestError: Raised when status_code is 400, or if you pass a uuid and a slug, or if
+                pinging by a slug and do not have a ping key set
+            HCAPIRateLimitError: Raised when status code is 429 or response text has "rate limited" in it
+            NonUniqueSlugError: Raused when status code is 409.
+
+        Returns:
+            CheckTrap: self
+        """
+        if isinstance(self.client, Client):
+            raise WrongClientError("You passed a sync Client, use this as a regular context manager")
+        result = await self.client.start_ping(self.uuid, self.slug)
+        if not result[0]:
+            raise PingFailedError(result[1])
+        return self
+
+    async def __aexit__(
+        self,
+        exc_type: Optional[Type[BaseException]],
+        exc: Optional[BaseException],
+        traceback: Optional[TracebackType],
+    ) -> Optional[bool]:
+        """Exit the context manager.
+
+        If there is an exception, add it to any log lines and send a fail ping.
+        Otherwise, send a success ping with any log lines appended.
+
+        Args:
+            exc_type (Optional[Type[BaseException]]): [description]
+            exc (Optional[BaseException]): [description]
+            traceback (Optional[TracebackType]): [description]
+
+        Returns:
+            Optional[bool]: self.suppress_exceptions, if true will not raise any exceptions
+        """
+        if exc_type is None:
+            # ignore typing, if we've gotten here we know its an async client
+            await self.client.success_ping(  # type: ignore
+                self.uuid, self.slug, data="\n".join(self.log_lines)
+            )
+        else:
+            self.add_log(str(exc))
+            self.add_log(str(traceback))
+            await self.client.fail_ping(  # type: ignore
+                self.uuid, self.slug, data="\n".join(self.log_lines)
+            )
+        return self.suppress_exceptions

src/healthchecks_io/client/exceptions.py

@@ -35,3 +35,15 @@ class NonUniqueSlugError(HCAPIError):
     """Thrown when the api returns a 409 when pinging."""
 
     ...
+
+
+class WrongClientError(HCAPIError):
+    """Thrown when trying to use a CheckTrap with the wrong client type."""
+
+    ...
+
+
+class PingFailedError(HCAPIError):
+    """Thrown when a ping fails."""
+
+    ...

src/healthchecks_io/client/sync_client.py

@@ -1,8 +1,11 @@
 """An async healthchecks.io client."""
+
+from types import TracebackType
 from typing import Dict
 from typing import List
 from typing import Optional
 from typing import Tuple
+from typing import Type
 
 from httpx import Client as HTTPXClient
 
@@ -50,6 +53,23 @@ class Client(AbstractClient):
         self._client.headers["user-agent"] = f"py-healthchecks.io/{client_version}"
         self._client.headers["Content-type"] = "application/json"
 
+    def __enter__(self) -> "Client":
+        """Context manager entrance.
+
+        Returns:
+            Client: returns this client as a context manager
+        """
+        return self
+
+    def __exit__(
+        self,
+        exc_type: Optional[Type[BaseException]],
+        exc: Optional[BaseException],
+        traceback: Optional[TracebackType],
+    ) -> None:
+        """Context manager exit."""
+        self._finalizer_method()
+
     def _finalizer_method(self) -> None:
         """Closes the httpx client."""
         self._client.close()
@@ -71,16 +91,11 @@ class Client(AbstractClient):
         request_url = self._get_api_request_url("checks/")
         if tags is not None:
             for tag in tags:
-                request_url = self._add_url_params(
-                    request_url, {"tag": tag}, replace=False
-                )
+                request_url = self._add_url_params(request_url, {"tag": tag}, replace=False)
 
         response = self.check_response(self._client.get(request_url))
 
-        return [
-            checks.Check.from_api_result(check_data)
-            for check_data in response.json()["checks"]
-        ]
+        return [checks.Check.from_api_result(check_data) for check_data in response.json()["checks"]]
 
     def get_check(self, check_id: str) -> checks.Check:
         """Get a single check by id.
@@ -118,9 +133,7 @@ class Client(AbstractClient):
             Check: check that was just created
         """
         request_url = self._get_api_request_url("checks/")
-        response = self.check_response(
-            self._client.post(request_url, json=new_check.dict())
-        )
+        response = self.check_response(self._client.post(request_url, json=new_check.dict(exclude_none=True)))
         return Check.from_api_result(response.json())
 
     def update_check(self, uuid: str, update_check: CheckCreate) -> Check:
@@ -144,7 +157,10 @@ class Client(AbstractClient):
         """
         request_url = self._get_api_request_url(f"checks/{uuid}")
         response = self.check_response(
-            self._client.post(request_url, json=update_check.dict(exclude_unset=True))
+            self._client.post(
+                request_url,
+                json=update_check.dict(exclude_unset=True, exclude_none=True),
+            )
         )
         return Check.from_api_result(response.json())
 
@@ -214,10 +230,7 @@ class Client(AbstractClient):
         """
         request_url = self._get_api_request_url(f"checks/{check_id}/pings/")
         response = self.check_response(self._client.get(request_url))
-        return [
-            checks.CheckPings.from_api_result(check_data)
-            for check_data in response.json()["pings"]
-        ]
+        return [checks.CheckPings.from_api_result(check_data) for check_data in response.json()["pings"]]
 
     def get_check_flips(
         self,
@@ -239,8 +252,10 @@ class Client(AbstractClient):
         Args:
             check_id (str): check uuid
             seconds (Optional[int], optional): Returns the flips from the last value seconds. Defaults to None.
-            start (Optional[int], optional): Returns flips that are newer than the specified UNIX timestamp.. Defaults to None.
-            end (Optional[int], optional): Returns flips that are older than the specified UNIX timestamp.. Defaults to None.
+            start (Optional[int], optional): Returns flips that are newer than the specified UNIX timestamp.
+                Defaults to None.
+            end (Optional[int], optional): Returns flips that are older than the specified UNIX timestamp.
+                Defaults to None.
 
         Returns:
             List[checks.CheckStatuses]: List of status flips for this check
@@ -285,7 +300,9 @@ class Client(AbstractClient):
         shields: returns JSON in a Shields.io compatible format.
         In addition, badges have 2-state and 3-state variations:
 
-        svg, json, shields: reports two states: "up" and "down". It considers any checks in the grace period as still "up".
+        svg, json, shields: reports two states: "up" and "down". It considers any checks in the grace period
+            as still "up".
+
         svg3, json3, shields3: reports three states: "up", "late", and "down".
 
         The response includes a special * entry: this pseudo-tag reports the overal status
@@ -300,12 +317,9 @@ class Client(AbstractClient):
         """
         request_url = self._get_api_request_url("badges/")
         response = self.check_response(self._client.get(request_url))
-        return {
-            key: badges.Badges.from_api_result(item)
-            for key, item in response.json()["badges"].items()
-        }
+        return {key: badges.Badges.from_api_result(item) for key, item in response.json()["badges"].items()}
 
-    def success_ping(self, uuid: str = "", slug: str = "") -> Tuple[bool, str]:
+    def success_ping(self, uuid: str = "", slug: str = "", data: str = "") -> Tuple[bool, str]:
         """Signals to Healthchecks.io that a job has completed successfully.
 
         Can also be used to indicate a continuously running process is still running and healthy.
@@ -321,6 +335,7 @@ class Client(AbstractClient):
         Args:
             uuid (str): Check's UUID. Defaults to "".
             slug (str): Check's Slug. Defaults to "".
+            data (str): Text data to append to this check. Defaults to ""
 
         Raises:
             HCAPIAuthError: Raised when status_code == 401 or 403
@@ -335,10 +350,10 @@ class Client(AbstractClient):
             Tuple[bool, str]: success (true or false) and the response text
         """
         ping_url = self._get_ping_url(uuid, slug, "")
-        response = self.check_ping_response(self._client.get(ping_url))
+        response = self.check_ping_response(self._client.post(ping_url, content=data))
         return (True if response.status_code == 200 else False, response.text)
 
-    def start_ping(self, uuid: str = "", slug: str = "") -> Tuple[bool, str]:
+    def start_ping(self, uuid: str = "", slug: str = "", data: str = "") -> Tuple[bool, str]:
         """Sends a "job has started!" message to Healthchecks.io.
 
         Sending a "start" signal is optional, but it enables a few extra features:
@@ -356,6 +371,7 @@ class Client(AbstractClient):
         Args:
             uuid (str): Check's UUID. Defaults to "".
             slug (str): Check's Slug. Defaults to "".
+            data (str): Text data to append to this check. Defaults to ""
 
         Raises:
             HCAPIAuthError: Raised when status_code == 401 or 403
@@ -370,10 +386,10 @@ class Client(AbstractClient):
             Tuple[bool, str]: success (true or false) and the response text
         """
         ping_url = self._get_ping_url(uuid, slug, "/start")
-        response = self.check_ping_response(self._client.get(ping_url))
+        response = self.check_ping_response(self._client.post(ping_url, content=data))
         return (True if response.status_code == 200 else False, response.text)
 
-    def fail_ping(self, uuid: str = "", slug: str = "") -> Tuple[bool, str]:
+    def fail_ping(self, uuid: str = "", slug: str = "", data: str = "") -> Tuple[bool, str]:
         """Signals to Healthchecks.io that the job has failed.
 
         Actively signaling a failure minimizes the delay from your monitored service failing to you receiving an alert.
@@ -389,6 +405,7 @@ class Client(AbstractClient):
         Args:
             uuid (str): Check's UUID. Defaults to "".
             slug (str): Check's Slug. Defaults to "".
+            data (str): Text data to append to this check. Defaults to ""
 
         Raises:
             HCAPIAuthError: Raised when status_code == 401 or 403
@@ -403,12 +420,10 @@ class Client(AbstractClient):
             Tuple[bool, str]: success (true or false) and the response text
         """
         ping_url = self._get_ping_url(uuid, slug, "/fail")
-        response = self.check_ping_response(self._client.get(ping_url))
+        response = self.check_ping_response(self._client.post(ping_url, content=data))
         return (True if response.status_code == 200 else False, response.text)
 
-    def exit_code_ping(
-        self, exit_code: int, uuid: str = "", slug: str = ""
-    ) -> Tuple[bool, str]:
+    def exit_code_ping(self, exit_code: int, uuid: str = "", slug: str = "", data: str = "") -> Tuple[bool, str]:
         """Signals to Healthchecks.io that the job has failed.
 
         Actively signaling a failure minimizes the delay from your monitored service failing to you receiving an alert.
@@ -425,6 +440,7 @@ class Client(AbstractClient):
             exit_code (int): Exit code to sent, int from 0 to 255
             uuid (str): Check's UUID. Defaults to "".
             slug (str): Check's Slug. Defaults to "".
+            data (str): Text data to append to this check. Defaults to ""
 
         Raises:
             HCAPIAuthError: Raised when status_code == 401 or 403
@@ -439,5 +455,5 @@ class Client(AbstractClient):
             Tuple[bool, str]: success (true or false) and the response text
         """
         ping_url = self._get_ping_url(uuid, slug, f"/{exit_code}")
-        response = self.check_ping_response(self._client.get(ping_url))
+        response = self.check_ping_response(self._client.post(ping_url, content=data))
         return (True if response.status_code == 200 else False, response.text)

src/healthchecks_io/schemas/__init__.py

@@ -1,4 +1,5 @@
 """Schemas for healthchecks_io."""
+
 from .badges import Badges
 from .checks import Check
 from .checks import CheckCreate

src/healthchecks_io/schemas/badges.py

@@ -2,6 +2,7 @@
 
 https://healthchecks.io/docs/api/
 """
+
 from typing import Dict
 
 from pydantic import BaseModel

src/healthchecks_io/schemas/checks.py

@@ -2,6 +2,7 @@
 
 https://healthchecks.io/docs/api/
 """
+
 from datetime import datetime
 from pathlib import PurePath
 from typing import Any
@@ -13,46 +14,45 @@ from urllib.parse import urlparse
 
 import pytz
 from croniter import croniter
-from pydantic import BaseModel
+from pydantic import field_validator, BaseModel, ValidationInfo
 from pydantic import Field
-from pydantic import validator
 
 
 class Check(BaseModel):
     """Schema for a check object, either from a readonly api request or a rw api request."""
 
-    unique_key: Optional[str]
+    unique_key: Optional[str] = None
     name: str
     slug: str
-    tags: Optional[str]
-    desc: Optional[str]
+    tags: Optional[str] = None
+    desc: Optional[str] = None
     grace: int
     n_pings: int
     status: str
-    last_ping: Optional[datetime]
-    next_ping: Optional[datetime]
+    last_ping: Optional[datetime] = None
+    next_ping: Optional[datetime] = None
     manual_resume: bool
-    methods: Optional[str]
+    methods: Optional[str] = None
     # healthchecks.io's api doesn't return a scheme so we cant use Pydantic AnyUrl here
-    ping_url: Optional[str]
-    update_url: Optional[str]
-    pause_url: Optional[str]
-    channels: Optional[str]
-    timeout: int
-    uuid: Optional[str]
+    ping_url: Optional[str] = None
+    update_url: Optional[str] = None
+    pause_url: Optional[str] = None
+    channels: Optional[str] = None
+    timeout: Optional[int] = None
+    uuid: Optional[str] = Field(default=None, validate_default=True)
 
-    @validator("uuid", always=True)
-    def validate_uuid(
-        cls, value: Optional[str], values: Dict[str, Any]  # noqa: B902
-    ) -> Optional[str]:
+    @field_validator("uuid")
+    @classmethod
+    def validate_uuid(cls, value: Optional[str], info: ValidationInfo) -> Optional[str]:  # noqa: B902
         """Tries to set the uuid from the ping_url.
 
         Will return none if a read only token is used because it cannot retrieve the UUID of a check
         """
-        if value is None and values.get("ping_url", None) is not None:
-            # url is like healthchecks.io/ping/8f57b84b-86c2-4546-8923-03f83d27604a, so we want just the UUID off the end
+        if value is None and info.data.get("ping_url", None) is not None:
+            # url is like healthchecks.io/ping/8f57b84b-86c2-4546-8923-03f83d27604a, so we want just the
+            # UUID off the end
             # Parse the url, grab the path and then just get the name using pathlib
-            path = PurePath(str(urlparse(values.get("ping_url")).path))
+            path = PurePath(str(urlparse(info.data.get("ping_url")).path))
             return path.name
         return value
 
@@ -65,11 +65,9 @@ class Check(BaseModel):
 class CheckCreate(BaseModel):
     """Pydantic object for creating a check."""
 
-    name: Optional[str] = Field(..., description="Name of the check")
-    tags: Optional[str] = Field(
-        ..., description="String separated list of tags to apply"
-    )
-    desc: Optional[str] = Field(..., description="Description of the check")
+    name: Optional[str] = Field("", description="Name of the check")
+    tags: Optional[str] = Field("", description="String separated list of tags to apply")
+    desc: Optional[str] = Field("", description="Description of the check")
     timeout: Optional[int] = Field(
         86400,
         description="The expected period of this check in seconds.",
@@ -83,7 +81,7 @@ class CheckCreate(BaseModel):
         lte=31536000,
     )
     schedule: Optional[str] = Field(
-        "* * * * *",
+        None,
         description="A cron expression defining this check's schedule. "
         "If you specify both timeout and schedule parameters, "
         "Healthchecks.io will create a Cron check and ignore the "
@@ -91,8 +89,7 @@ class CheckCreate(BaseModel):
     )
     tz: Optional[str] = Field(
         "UTC",
-        description="Server's timezone. This setting only has an effect "
-        "in combination with the schedule parameter.",
+        description="Server's timezone. This setting only has an effect " "in combination with the schedule parameter.",
     )
     manual_resume: Optional[bool] = Field(
         False,
@@ -129,30 +126,32 @@ class CheckCreate(BaseModel):
         "for the unique field are name, tags, timeout, and grace.",
     )
 
-    @validator("schedule")
+    @field_validator("schedule")
+    @classmethod
     def validate_schedule(cls, value: str) -> str:
         """Validates that the schedule is a valid cron expression."""
         if not croniter.is_valid(value):
             raise ValueError("Schedule is not a valid cron expression")
         return value
 
-    @validator("tz")
+    @field_validator("tz")
+    @classmethod
     def validate_tz(cls, value: str) -> str:
         """Validates that the timezone is a valid timezone string."""
         if value not in pytz.all_timezones:
             raise ValueError("Tz is not a valid timezone")
         return value
 
-    @validator("methods")
+    @field_validator("methods")
+    @classmethod
     def validate_methods(cls, value: str) -> str:
         """Validate that methods."""
         if value not in ("", "POST"):
-            raise ValueError(
-                "Methods is invalid, it should be either an empty string or POST"
-            )
+            raise ValueError("Methods is invalid, it should be either an empty string or POST")
         return value
 
-    @validator("unique")
+    @field_validator("unique")
+    @classmethod
     def validate_unique(cls, value: List[Optional[str]]) -> List[Optional[str]]:
         """Validate unique list."""
         for unique in value:
@@ -167,9 +166,7 @@ class CheckUpdate(CheckCreate):
     """Pydantic object for updating a check."""
 
     name: Optional[str] = Field(None, description="Name of the check")
-    tags: Optional[str] = Field(
-        None, description="String separated list of tags to apply"
-    )
+    tags: Optional[str] = Field(None, description="String separated list of tags to apply")
     timeout: Optional[int] = Field(
         None,
         description="The expected period of this check in seconds.",
@@ -191,8 +188,7 @@ class CheckUpdate(CheckCreate):
     )
     tz: Optional[str] = Field(
         None,
-        description="Server's timezone. This setting only has an effect "
-        "in combination with the schedule parameter.",
+        description="Server's timezone. This setting only has an effect " "in combination with the schedule parameter.",
     )
     manual_resume: Optional[bool] = Field(
         None,
@@ -243,9 +239,7 @@ class CheckPings(BaseModel):
     duration: Optional[float] = None
 
     @classmethod
-    def from_api_result(
-        cls, ping_dict: Dict[str, Union[str, int, datetime]]
-    ) -> "CheckPings":
+    def from_api_result(cls, ping_dict: Dict[str, Union[str, int, datetime]]) -> "CheckPings":
         """Converts a dictionary from the healthchecks api into a CheckPings object."""
         ping_dict["number_of_pings"] = ping_dict["n"]
         ping_dict["user_agent"] = ping_dict["ua"]

src/healthchecks_io/schemas/integrations.py

@@ -2,6 +2,7 @@
 
 https://healthchecks.io/docs/api/
 """
+
 from typing import Dict
 
 from pydantic import BaseModel

tests/client/test_abstract.py

@@ -10,14 +10,10 @@ from healthchecks_io import HCAPIAuthError
 from healthchecks_io import HCAPIError
 from healthchecks_io import HCAPIRateLimitError
 from healthchecks_io import NonUniqueSlugError
-from healthchecks_io.client._abstract import AbstractClient
 
 
 def test_abstract_add_url_params(test_abstract_client):
-
-    url = test_abstract_client._add_url_params(
-        "http://test.com/?test=test", {"test": "test2"}
-    )
+    url = test_abstract_client._add_url_params("http://test.com/?test=test", {"test": "test2"})
     assert url == "http://test.com/?test=test2"
 
 

tests/client/test_async.py

@@ -1,7 +1,6 @@
 from urllib.parse import urljoin
 
 import pytest
-import respx
 from httpx import AsyncClient as HTTPXAsyncClient
 from httpx import Response
 
@@ -14,6 +13,38 @@ from healthchecks_io.client.exceptions import HCAPIAuthError
 from healthchecks_io.client.exceptions import HCAPIError
 
 
+@pytest.mark.asyncio
+@pytest.mark.respx
+async def test_acreate_check_200_context_manager(fake_check_api_result, respx_mock, test_async_client):
+    checks_url = urljoin(test_async_client._api_url, "checks/")
+    respx_mock.post(checks_url).mock(
+        return_value=Response(
+            status_code=200,
+            json={
+                "channels": "",
+                "desc": "",
+                "grace": 60,
+                "last_ping": None,
+                "n_pings": 0,
+                "name": "Backups",
+                "slug": "backups",
+                "next_ping": None,
+                "manual_resume": False,
+                "methods": "",
+                "pause_url": "https://healthchecks.io/api/v1/checks/f618072a-7bde-4eee-af63-71a77c5723bc/pause",
+                "ping_url": "https://hc-ping.com/f618072a-7bde-4eee-af63-71a77c5723bc",
+                "status": "new",
+                "tags": "prod www",
+                "timeout": 3600,
+                "update_url": "https://healthchecks.io/api/v1/checks/f618072a-7bde-4eee-af63-71a77c5723bc",
+            },
+        )
+    )
+    async with test_async_client as test_client:
+        check = await test_client.create_check(CheckCreate(name="test", tags="test", desc="test"))
+    assert check.name == "Backups"
+
+
 @pytest.mark.asyncio
 @pytest.mark.respx
 async def test_acreate_check_200(fake_check_api_result, respx_mock, test_async_client):
@@ -41,9 +72,7 @@ async def test_acreate_check_200(fake_check_api_result, respx_mock, test_async_c
             },
         )
     )
-    check = await test_async_client.create_check(
-        CheckCreate(name="test", tags="test", desc="test")
-    )
+    check = await test_async_client.create_check(CheckCreate(name="test", tags="test", desc="test"))
     assert check.name == "Backups"
 
 
@@ -74,9 +103,7 @@ async def test_aupdate_check_200(fake_check_api_result, respx_mock, test_async_c
             },
         )
     )
-    check = await test_async_client.update_check(
-        "test", CheckUpdate(name="test", desc="test")
-    )
+    check = await test_async_client.update_check("test", CheckUpdate(name="test", desc="test"))
     assert check.name == "Backups"
 
 
@@ -85,9 +112,7 @@ async def test_aupdate_check_200(fake_check_api_result, respx_mock, test_async_c
 async def test_aget_checks_200(fake_check_api_result, respx_mock, test_async_client):
     assert test_async_client._client is not None
     checks_url = urljoin(test_async_client._api_url, "checks/")
-    respx_mock.get(checks_url).mock(
-        return_value=Response(status_code=200, json={"checks": [fake_check_api_result]})
-    )
+    respx_mock.get(checks_url).mock(return_value=Response(status_code=200, json={"checks": [fake_check_api_result]}))
     checks = await test_async_client.get_checks()
     assert len(checks) == 1
     assert checks[0].name == fake_check_api_result["name"]
@@ -97,13 +122,9 @@ async def test_aget_checks_200(fake_check_api_result, respx_mock, test_async_cli
 @pytest.mark.respx
 async def test_aget_checks_pass_in_client(fake_check_api_result, respx_mock):
     httpx_client = HTTPXAsyncClient()
-    test_async_client = AsyncClient(
-        api_key="test", api_url="http://localhost/api/", client=httpx_client
-    )
+    test_async_client = AsyncClient(api_key="test", api_url="http://localhost/api/", client=httpx_client)
     checks_url = urljoin(test_async_client._api_url, "checks/")
-    respx_mock.get(checks_url).mock(
-        return_value=Response(status_code=200, json={"checks": [fake_check_api_result]})
-    )
+    respx_mock.get(checks_url).mock(return_value=Response(status_code=200, json={"checks": [fake_check_api_result]}))
     checks = await test_async_client.get_checks()
     assert len(checks) == 1
     assert checks[0].name == fake_check_api_result["name"]
@@ -111,9 +132,7 @@ async def test_aget_checks_pass_in_client(fake_check_api_result, respx_mock):
 
 @pytest.mark.asyncio
 @pytest.mark.respx
-async def test_aget_checks_exceptions(
-    fake_check_api_result, respx_mock, test_async_client
-):
+async def test_aget_checks_exceptions(fake_check_api_result, respx_mock, test_async_client):
     checks_url = urljoin(test_async_client._api_url, "checks/")
     # test exceptions
     respx_mock.get(checks_url).mock(return_value=Response(status_code=401))
@@ -151,9 +170,7 @@ def test_finalizer_closes(test_async_client):
 async def test_aget_check_200(fake_check_api_result, respx_mock, test_async_client):
     assert test_async_client._client is not None
     checks_url = urljoin(test_async_client._api_url, "checks/test")
-    respx_mock.get(checks_url).mock(
-        return_value=Response(status_code=200, json=fake_check_api_result)
-    )
+    respx_mock.get(checks_url).mock(return_value=Response(status_code=200, json=fake_check_api_result))
     check = await test_async_client.get_check(check_id="test")
     assert check.name == fake_check_api_result["name"]
 
@@ -172,9 +189,7 @@ async def test_acheck_get_404(respx_mock, test_async_client):
 @pytest.mark.respx
 async def test_pause_check_200(fake_check_api_result, respx_mock, test_async_client):
     checks_url = urljoin(test_async_client._api_url, "checks/test/pause")
-    respx_mock.post(checks_url).mock(
-        return_value=Response(status_code=200, json=fake_check_api_result)
-    )
+    respx_mock.post(checks_url).mock(return_value=Response(status_code=200, json=fake_check_api_result))
     check = await test_async_client.pause_check(check_id="test")
     assert check.name == fake_check_api_result["name"]
 
@@ -194,9 +209,7 @@ async def test_acheck_pause_404(respx_mock, test_async_client):
 async def test_adelete_check_200(fake_check_api_result, respx_mock, test_async_client):
     assert test_async_client._client is not None
     checks_url = urljoin(test_async_client._api_url, "checks/test")
-    respx_mock.delete(checks_url).mock(
-        return_value=Response(status_code=200, json=fake_check_api_result)
-    )
+    respx_mock.delete(checks_url).mock(return_value=Response(status_code=200, json=fake_check_api_result))
     check = await test_async_client.delete_check(check_id="test")
     assert check.name == fake_check_api_result["name"]
 
@@ -212,15 +225,9 @@ async def test_adelete_pause404(respx_mock, test_async_client):
 
 @pytest.mark.asyncio
 @pytest.mark.respx
-async def test_aget_check_pings_200(
-    fake_check_pings_api_result, respx_mock, test_async_client
-):
+async def test_aget_check_pings_200(fake_check_pings_api_result, respx_mock, test_async_client):
     checks_url = urljoin(test_async_client._api_url, "checks/test/pings/")
-    respx_mock.get(checks_url).mock(
-        return_value=Response(
-            status_code=200, json={"pings": fake_check_pings_api_result}
-        )
-    )
+    respx_mock.get(checks_url).mock(return_value=Response(status_code=200, json={"pings": fake_check_pings_api_result}))
     pings = await test_async_client.get_check_pings("test")
     assert len(pings) == len(fake_check_pings_api_result)
     assert pings[0].type == fake_check_pings_api_result[0]["type"]
@@ -228,13 +235,9 @@ async def test_aget_check_pings_200(
 
 @pytest.mark.asyncio
 @pytest.mark.respx
-async def test_aget_check_flips_200(
-    fake_check_flips_api_result, respx_mock, test_async_client
-):
+async def test_aget_check_flips_200(fake_check_flips_api_result, respx_mock, test_async_client):
     checks_url = urljoin(test_async_client._api_url, "checks/test/flips/")
-    respx_mock.get(checks_url).mock(
-        return_value=Response(status_code=200, json=fake_check_flips_api_result)
-    )
+    respx_mock.get(checks_url).mock(return_value=Response(status_code=200, json=fake_check_flips_api_result))
     flips = await test_async_client.get_check_flips("test")
     assert len(flips) == len(fake_check_flips_api_result)
     assert flips[0].up == fake_check_flips_api_result[0]["up"]
@@ -242,15 +245,9 @@ async def test_aget_check_flips_200(
 
 @pytest.mark.asyncio
 @pytest.mark.respx
-async def test_get_check_flips_params_200(
-    fake_check_flips_api_result, respx_mock, test_async_client
-):
-    checks_url = urljoin(
-        test_async_client._api_url, "checks/test/flips/?seconds=1&start=1&end=1"
-    )
-    respx_mock.get(checks_url).mock(
-        return_value=Response(status_code=200, json=fake_check_flips_api_result)
-    )
+async def test_get_check_flips_params_200(fake_check_flips_api_result, respx_mock, test_async_client):
+    checks_url = urljoin(test_async_client._api_url, "checks/test/flips/?seconds=1&start=1&end=1")
+    respx_mock.get(checks_url).mock(return_value=Response(status_code=200, json=fake_check_flips_api_result))
     flips = await test_async_client.get_check_flips("test", seconds=1, start=1, end=1)
     assert len(flips) == len(fake_check_flips_api_result)
     assert flips[0].up == fake_check_flips_api_result[0]["up"]
@@ -258,9 +255,7 @@ async def test_get_check_flips_params_200(
 
 @pytest.mark.asyncio
 @pytest.mark.respx
-async def test_aget_check_flips_400(
-    fake_check_flips_api_result, respx_mock, test_async_client
-):
+async def test_aget_check_flips_400(fake_check_flips_api_result, respx_mock, test_async_client):
     flips_url = urljoin(test_async_client._api_url, "checks/test/flips/")
     respx_mock.get(flips_url).mock(return_value=Response(status_code=400))
     with pytest.raises(BadAPIRequestError):
@@ -269,13 +264,9 @@ async def test_aget_check_flips_400(
 
 @pytest.mark.asyncio
 @pytest.mark.respx
-async def test_aget_integrations(
-    fake_integrations_api_result, respx_mock, test_async_client
-):
+async def test_aget_integrations(fake_integrations_api_result, respx_mock, test_async_client):
     channels_url = urljoin(test_async_client._api_url, "channels/")
-    respx_mock.get(channels_url).mock(
-        return_value=Response(status_code=200, json=fake_integrations_api_result)
-    )
+    respx_mock.get(channels_url).mock(return_value=Response(status_code=200, json=fake_integrations_api_result))
     integrations = await test_async_client.get_integrations()
     assert len(integrations) == len(fake_integrations_api_result["channels"])
     assert integrations[0].id == fake_integrations_api_result["channels"][0]["id"]
@@ -285,9 +276,7 @@ async def test_aget_integrations(
 @pytest.mark.respx
 async def test_aget_badges(fake_badges_api_result, respx_mock, test_async_client):
     channels_url = urljoin(test_async_client._api_url, "badges/")
-    respx_mock.get(channels_url).mock(
-        return_value=Response(status_code=200, json=fake_badges_api_result)
-    )
+    respx_mock.get(channels_url).mock(return_value=Response(status_code=200, json=fake_badges_api_result))
     integrations = await test_async_client.get_badges()
     assert integrations.keys() == fake_badges_api_result["badges"].keys()
 
@@ -354,14 +343,10 @@ ping_test_parameters = [
 
 @pytest.mark.asyncio
 @pytest.mark.respx
-@pytest.mark.parametrize(
-    "respx_mocker, tc, url, ping_method, method_kwargs", ping_test_parameters
-)
-async def test_success_ping(respx_mocker, tc, url, ping_method, method_kwargs):
+@pytest.mark.parametrize("respx_mocker, tc, url, ping_method, method_kwargs", ping_test_parameters)
+async def test_asuccess_ping(respx_mocker, tc, url, ping_method, method_kwargs):
     channels_url = urljoin(tc._ping_url, url)
-    respx_mocker.get(channels_url).mock(
-        return_value=Response(status_code=200, text="OK")
-    )
+    respx_mocker.post(channels_url).mock(return_value=Response(status_code=200, text="OK"))
     ping_method = getattr(tc, ping_method)
     result = await ping_method(**method_kwargs)
     assert result[0] is True

tests/client/test_check_trap.py

@@ -0,0 +1,92 @@
+from urllib.parse import urljoin
+
+import pytest
+from httpx import Response
+
+from healthchecks_io import CheckTrap
+from healthchecks_io import PingFailedError
+from healthchecks_io import WrongClientError
+
+
+@pytest.mark.respx
+def test_check_trap_sync(respx_mock, test_client):
+    start_url = urljoin(test_client._ping_url, "test/start")
+    respx_mock.post(start_url).mock(return_value=Response(status_code=200, text="OK"))
+    success_url = urljoin(test_client._ping_url, "test")
+    respx_mock.post(success_url).mock(return_value=Response(status_code=200, text="OK"))
+
+    with CheckTrap(test_client, uuid="test"):
+        pass
+
+
+@pytest.mark.respx
+def test_check_trap_sync_failed_ping(respx_mock, test_client):
+    start_url = urljoin(test_client._ping_url, "test/start")
+    respx_mock.post(start_url).mock(return_value=Response(status_code=444, text="OK"))
+    with pytest.raises(PingFailedError):
+        with CheckTrap(test_client, uuid="test"):
+            pass
+
+
+@pytest.mark.respx
+def test_check_trap_sync_exception(respx_mock, test_client):
+    start_url = urljoin(test_client._ping_url, "test/start")
+    respx_mock.post(start_url).mock(return_value=Response(status_code=200, text="OK"))
+    fail_url = urljoin(test_client._ping_url, "test/fail")
+    respx_mock.post(fail_url).mock(return_value=Response(status_code=200, text="OK"))
+    with pytest.raises(Exception):
+        with CheckTrap(test_client, uuid="test"):
+            raise Exception("Exception")
+
+
+@pytest.mark.asyncio
+@pytest.mark.respx
+async def test_check_trap_async(respx_mock, test_async_client):
+    start_url = urljoin(test_async_client._ping_url, "test/start")
+    respx_mock.post(start_url).mock(return_value=Response(status_code=200, text="OK"))
+    success_url = urljoin(test_async_client._ping_url, "test")
+    respx_mock.post(success_url).mock(return_value=Response(status_code=200, text="OK"))
+
+    async with CheckTrap(test_async_client, uuid="test"):
+        pass
+
+
+@pytest.mark.asyncio
+@pytest.mark.respx
+async def test_check_trap_async_failed_ping(respx_mock, test_async_client):
+    start_url = urljoin(test_async_client._ping_url, "test/start")
+    respx_mock.post(start_url).mock(return_value=Response(status_code=444, text="OK"))
+    with pytest.raises(PingFailedError):
+        async with CheckTrap(test_async_client, uuid="test"):
+            pass
+
+
+@pytest.mark.asyncio
+@pytest.mark.respx
+async def test_check_trap_async_exception(respx_mock, test_async_client):
+    start_url = urljoin(test_async_client._ping_url, "test/start")
+    respx_mock.post(start_url).mock(return_value=Response(status_code=200, text="OK"))
+    fail_url = urljoin(test_async_client._ping_url, "test/fail")
+    respx_mock.post(fail_url).mock(return_value=Response(status_code=200, text="OK"))
+
+    with pytest.raises(Exception):
+        async with CheckTrap(test_async_client, uuid="test"):
+            raise Exception("Exception")
+
+
+@pytest.mark.asyncio
+async def test_check_trap_wrong_client_error(test_client, test_async_client):
+    with pytest.raises(WrongClientError):
+        async with CheckTrap(test_client, uuid="test"):
+            pass
+
+    with pytest.raises(WrongClientError):
+        with CheckTrap(test_async_client, uuid="test"):
+            pass
+
+
+def test_check_trap_no_uuid_or_slug(test_client):
+    with pytest.raises(Exception) as exc:
+        with CheckTrap(test_client):
+            pass
+        assert str(exc) == "Must pass a slug or an uuid"

tests/client/test_sync.py

@@ -1,7 +1,6 @@
 from urllib.parse import urljoin
 
 import pytest
-import respx
 from httpx import Client as HTTPXClient
 from httpx import Response
 
@@ -14,6 +13,37 @@ from healthchecks_io.client.exceptions import HCAPIAuthError
 from healthchecks_io.client.exceptions import HCAPIError
 
 
+@pytest.mark.respx
+def test_create_check_200_context_manager(fake_check_api_result, respx_mock, test_client):
+    checks_url = urljoin(test_client._api_url, "checks/")
+    respx_mock.post(checks_url).mock(
+        return_value=Response(
+            status_code=200,
+            json={
+                "channels": "",
+                "desc": "",
+                "grace": 60,
+                "last_ping": None,
+                "n_pings": 0,
+                "name": "Backups",
+                "slug": "backups",
+                "next_ping": None,
+                "manual_resume": False,
+                "methods": "",
+                "pause_url": "https://healthchecks.io/api/v1/checks/f618072a-7bde-4eee-af63-71a77c5723bc/pause",
+                "ping_url": "https://hc-ping.com/f618072a-7bde-4eee-af63-71a77c5723bc",
+                "status": "new",
+                "tags": "prod www",
+                "timeout": 3600,
+                "update_url": "https://healthchecks.io/api/v1/checks/f618072a-7bde-4eee-af63-71a77c5723bc",
+            },
+        )
+    )
+    with test_client as tc:
+        check = tc.create_check(CheckCreate(name="test", tags="test", desc="test"))
+    assert check.name == "Backups"
+
+
 @pytest.mark.respx
 def test_create_check_200(fake_check_api_result, respx_mock, test_client):
     checks_url = urljoin(test_client._api_url, "checks/")
@@ -78,9 +108,7 @@ def test_update_check_200(fake_check_api_result, respx_mock, test_client):
 def test_get_checks_200(fake_check_api_result, respx_mock, test_client):
     assert test_client._client is not None
     checks_url = urljoin(test_client._api_url, "checks/")
-    respx_mock.get(checks_url).mock(
-        return_value=Response(status_code=200, json={"checks": [fake_check_api_result]})
-    )
+    respx_mock.get(checks_url).mock(return_value=Response(status_code=200, json={"checks": [fake_check_api_result]}))
     checks = test_client.get_checks()
     assert len(checks) == 1
     assert checks[0].name == fake_check_api_result["name"]
@@ -89,13 +117,9 @@ def test_get_checks_200(fake_check_api_result, respx_mock, test_client):
 @pytest.mark.respx
 def test_get_checks_pass_in_client(fake_check_api_result, respx_mock):
     httpx_client = HTTPXClient()
-    test_client = Client(
-        api_key="test", api_url="http://localhost/api/", client=httpx_client
-    )
+    test_client = Client(api_key="test", api_url="http://localhost/api/", client=httpx_client)
     checks_url = urljoin(test_client._api_url, "checks/")
-    respx_mock.get(checks_url).mock(
-        return_value=Response(status_code=200, json={"checks": [fake_check_api_result]})
-    )
+    respx_mock.get(checks_url).mock(return_value=Response(status_code=200, json={"checks": [fake_check_api_result]}))
     checks = test_client.get_checks()
     assert len(checks) == 1
     assert checks[0].name == fake_check_api_result["name"]
@@ -137,9 +161,7 @@ def test_finalizer_closes(test_client):
 def test_get_check_200(fake_check_api_result, respx_mock, test_client):
     assert test_client._client is not None
     checks_url = urljoin(test_client._api_url, "checks/test")
-    respx_mock.get(checks_url).mock(
-        return_value=Response(status_code=200, json=fake_check_api_result)
-    )
+    respx_mock.get(checks_url).mock(return_value=Response(status_code=200, json=fake_check_api_result))
     check = test_client.get_check(check_id="test")
     assert check.name == fake_check_api_result["name"]
 
@@ -156,9 +178,7 @@ def test_check_get_404(respx_mock, test_client):
 @pytest.mark.respx
 def test_pause_check_200(fake_check_api_result, respx_mock, test_client):
     checks_url = urljoin(test_client._api_url, "checks/test/pause")
-    respx_mock.post(checks_url).mock(
-        return_value=Response(status_code=200, json=fake_check_api_result)
-    )
+    respx_mock.post(checks_url).mock(return_value=Response(status_code=200, json=fake_check_api_result))
     check = test_client.pause_check(check_id="test")
     assert check.name == fake_check_api_result["name"]
 
@@ -176,9 +196,7 @@ def test_check_pause_404(respx_mock, test_client):
 def test_delete_check_200(fake_check_api_result, respx_mock, test_client):
     assert test_client._client is not None
     checks_url = urljoin(test_client._api_url, "checks/test")
-    respx_mock.delete(checks_url).mock(
-        return_value=Response(status_code=200, json=fake_check_api_result)
-    )
+    respx_mock.delete(checks_url).mock(return_value=Response(status_code=200, json=fake_check_api_result))
     check = test_client.delete_check(check_id="test")
     assert check.name == fake_check_api_result["name"]
 
@@ -194,11 +212,7 @@ def test_delete_pause404(respx_mock, test_client):
 @pytest.mark.respx
 def test_get_check_pings_200(fake_check_pings_api_result, respx_mock, test_client):
     checks_url = urljoin(test_client._api_url, "checks/test/pings/")
-    respx_mock.get(checks_url).mock(
-        return_value=Response(
-            status_code=200, json={"pings": fake_check_pings_api_result}
-        )
-    )
+    respx_mock.get(checks_url).mock(return_value=Response(status_code=200, json={"pings": fake_check_pings_api_result}))
     pings = test_client.get_check_pings("test")
     assert len(pings) == len(fake_check_pings_api_result)
     assert pings[0].type == fake_check_pings_api_result[0]["type"]
@@ -207,24 +221,16 @@ def test_get_check_pings_200(fake_check_pings_api_result, respx_mock, test_clien
 @pytest.mark.respx
 def test_get_check_flips_200(fake_check_flips_api_result, respx_mock, test_client):
     checks_url = urljoin(test_client._api_url, "checks/test/flips/")
-    respx_mock.get(checks_url).mock(
-        return_value=Response(status_code=200, json=fake_check_flips_api_result)
-    )
+    respx_mock.get(checks_url).mock(return_value=Response(status_code=200, json=fake_check_flips_api_result))
     flips = test_client.get_check_flips("test")
     assert len(flips) == len(fake_check_flips_api_result)
     assert flips[0].up == fake_check_flips_api_result[0]["up"]
 
 
 @pytest.mark.respx
-def test_get_check_flips_params_200(
-    fake_check_flips_api_result, respx_mock, test_client
-):
-    checks_url = urljoin(
-        test_client._api_url, "checks/test/flips/?seconds=1&start=1&end=1"
-    )
-    respx_mock.get(checks_url).mock(
-        return_value=Response(status_code=200, json=fake_check_flips_api_result)
-    )
+def test_get_check_flips_params_200(fake_check_flips_api_result, respx_mock, test_client):
+    checks_url = urljoin(test_client._api_url, "checks/test/flips/?seconds=1&start=1&end=1")
+    respx_mock.get(checks_url).mock(return_value=Response(status_code=200, json=fake_check_flips_api_result))
     flips = test_client.get_check_flips("test", seconds=1, start=1, end=1)
     assert len(flips) == len(fake_check_flips_api_result)
     assert flips[0].up == fake_check_flips_api_result[0]["up"]
@@ -241,9 +247,7 @@ def test_get_check_flips_400(fake_check_flips_api_result, respx_mock, test_clien
 @pytest.mark.respx
 def test_get_integrations(fake_integrations_api_result, respx_mock, test_client):
     channels_url = urljoin(test_client._api_url, "channels/")
-    respx_mock.get(channels_url).mock(
-        return_value=Response(status_code=200, json=fake_integrations_api_result)
-    )
+    respx_mock.get(channels_url).mock(return_value=Response(status_code=200, json=fake_integrations_api_result))
     integrations = test_client.get_integrations()
     assert len(integrations) == len(fake_integrations_api_result["channels"])
     assert integrations[0].id == fake_integrations_api_result["channels"][0]["id"]
@@ -252,9 +256,7 @@ def test_get_integrations(fake_integrations_api_result, respx_mock, test_client)
 @pytest.mark.respx
 def test_get_badges(fake_badges_api_result, respx_mock, test_client):
     channels_url = urljoin(test_client._api_url, "badges/")
-    respx_mock.get(channels_url).mock(
-        return_value=Response(status_code=200, json=fake_badges_api_result)
-    )
+    respx_mock.get(channels_url).mock(return_value=Response(status_code=200, json=fake_badges_api_result))
     integrations = test_client.get_badges()
     assert integrations.keys() == fake_badges_api_result["badges"].keys()
 
@@ -320,14 +322,10 @@ ping_test_parameters = [
 
 
 @pytest.mark.respx
-@pytest.mark.parametrize(
-    "respx_mocker, tc, url, ping_method, method_kwargs", ping_test_parameters
-)
+@pytest.mark.parametrize("respx_mocker, tc, url, ping_method, method_kwargs", ping_test_parameters)
 def test_success_ping(respx_mocker, tc, url, ping_method, method_kwargs):
     channels_url = urljoin(tc._ping_url, url)
-    respx_mocker.get(channels_url).mock(
-        return_value=Response(status_code=200, text="OK")
-    )
+    respx_mocker.post(channels_url).mock(return_value=Response(status_code=200, text="OK"))
     ping_method = getattr(tc, ping_method)
     result, text = ping_method(**method_kwargs)
     assert result is True

tests/schemas/test_checks.py

@@ -37,27 +37,19 @@ def test_check_create_validators():
 
     # test validate_schedule
     with pytest.raises(ValidationError):
-        check_create = checks.CheckCreate(
-            name="Test", tags="", desc="Test", schedule="no good"
-        )
+        check_create = checks.CheckCreate(name="Test", tags="", desc="Test", schedule="no good")
 
     # test validate_tz
     with pytest.raises(ValidationError):
-        check_create = checks.CheckCreate(
-            name="Test", tags="", desc="Test", tz="no good"
-        )
+        check_create = checks.CheckCreate(name="Test", tags="", desc="Test", tz="no good")
 
     # test validate_methods
     with pytest.raises(ValidationError):
-        check_create = checks.CheckCreate(
-            name="Test", tags="", desc="Test", methods="no good"
-        )
+        check_create = checks.CheckCreate(name="Test", tags="", desc="Test", methods="no good")
 
     # test validate_unique
     with pytest.raises(ValidationError):
-        check_create = checks.CheckCreate(
-            name="Test", tags="", desc="Test", unique=["no good"]
-        )
+        check_create = checks.CheckCreate(name="Test", tags="", desc="Test", unique=["no good"])
 
 
 def test_check_pings_from_api():