chore(main): release 0.4.0 (#393)

* feat: add python 3.11 support

- adds testing for python 3.11
- moves from black and flake8 to ruff for linting
- Updates coverage output from tests

* fix: fix dev dependency group

* fix: add installing dev dependencies

* ci: add toml

* ci: simplify coverage

* ci: update coverage

.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/workflows/constraints.txt

@@ -1,6 +1,7 @@
-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==23.0.1
+nox==2022.11.21
+nox-poetry==1.0.2
+poetry==1.3.2
+virtualenv==20.19.0
+poetry-dynamic-versioning==0.21.3
+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@v3
+      - 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@v3.1.0
 
       - name: Run Labeler
-        uses: crazy-max/ghaction-github-labeler@v3.1.1
+        uses: crazy-max/ghaction-github-labeler@v4.1.0
         with:
           skip-delete: true

.github/workflows/pre-release.yml

@@ -1,4 +1,4 @@
-name: Release
+name: Pre-release to pypi
 
 on:
   release:
@@ -10,12 +10,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out the repository
-        uses: actions/checkout@v2.4.0
+        uses: actions/checkout@v3.1.0
         with:
           fetch-depth: 2
 
       - name: Set up Python
-        uses: actions/setup-python@v2.3.1
+        uses: actions/setup-python@v4.5.0
         with:
           python-version: "3.10"
 
@@ -34,17 +34,8 @@ 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.6.4
         with:
           user: __token__
           password: ${{ secrets.TEST_PYPI_TOKEN }}
           repository_url: https://test.pypi.org/legacy/
-
-      - name: Publish the release notes
-        uses: release-drafter/release-drafter@v5.15.0
-        with:
-          publish: ${{ steps.check-version.outputs.tag != '' }}
-          tag: ${{ steps.check-version.outputs.tag }}
-        env:
-          GITHUB_TOKEN: ${{ secrets.GH_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@v3
+        with:
+          token: ${{ secrets.THIS_PAT }}
+          release-type: python

.github/workflows/release.yml

@@ -0,0 +1,39 @@
+name: Release to pypi
+
+on:
+  release:
+    types: [released]
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out the repository
+        uses: actions/checkout@v3.1.0
+        with:
+          fetch-depth: 2
+      - name: Set up Python
+        uses: actions/setup-python@v4.5.0
+        with:
+          python-version: "3.10"
+
+      - name: Upgrade pip
+        run: |
+          pip install --constraint=.github/workflows/constraints.txt pip
+          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.6.4
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_TOKEN }}

.github/workflows/tests.yml

@@ -2,7 +2,6 @@ name: Tests
 
 on:
   - push
-  - pull_request
 
 jobs:
   tests:
@@ -14,17 +13,18 @@ jobs:
         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.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: "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" }
+          # poetry fails to install on windows
+          # - { python: "3.10", os: "windows-latest", session: "tests" }
+          - { python: "3.11", os: "macos-latest", session: "tests" }
           - { python: "3.10", os: "ubuntu-latest", session: "xdoctest" }
           - { python: "3.10", os: "ubuntu-latest", session: "docs-build" }
 
@@ -35,10 +35,10 @@ jobs:
 
     steps:
       - name: Check out the repository
-        uses: actions/checkout@v2.4.0
+        uses: actions/checkout@v3.1.0
 
       - name: Set up Python ${{ matrix.python }}
-        uses: actions/setup-python@v2.3.1
+        uses: actions/setup-python@v4.5.0
         with:
           python-version: ${{ matrix.python }}
 
@@ -64,7 +64,7 @@ jobs:
       - 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
+          pipx inject --pip-args=--constraint=.github/workflows/constraints.txt nox nox-poetry toml
           nox --version
 
       - name: Compute pre-commit cache key
@@ -74,16 +74,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@v3.2.5
         if: matrix.session == 'pre-commit'
         with:
           path: ~/.cache/pre-commit
@@ -97,14 +99,14 @@ jobs:
 
       - name: Upload coverage data
         if: always() && matrix.session == 'tests'
-        uses: "actions/upload-artifact@v2.3.1"
+        uses: "actions/upload-artifact@v3.1.2"
         with:
           name: coverage-data
           path: ".coverage.*"
 
       - name: Upload documentation
         if: matrix.session == 'docs-build'
-        uses: actions/upload-artifact@v2.3.1
+        uses: actions/upload-artifact@v3.1.2
         with:
           name: docs
           path: docs/_build
@@ -113,42 +115,13 @@ jobs:
     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
+        uses: actions/download-artifact@v3.0.2
         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
+        uses: codecov/codecov-action@v3.1.1
+        with:
+          files: .coverage.xml
+          verbose: true

.gitignore

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

.pre-commit-config.yaml

@@ -1,12 +1,20 @@
 repos:
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    # Ruff version.
+    rev: "v0.0.249"
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+        types: [python]
   - repo: local
     hooks:
-      - id: black
-        name: black
-        entry: black
+      - id: bandit
+        name: bandit
+        entry: bandit
         language: system
         types: [python]
         require_serial: true
+        args: ["-c", "bandit.yml"]
       - id: check-added-large-files
         name: Check for added large files
         entry: check-added-large-files
@@ -27,13 +35,6 @@ 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.
@@ -54,6 +55,10 @@ repos:
         types: [text]
         stages: [commit, push, manual]
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v2.5.1
+    rev: v2.7.1
     hooks:
       - id: prettier
+  - repo: https://github.com/rhysd/actionlint
+    rev: v1.6.15
+    hooks:
+      - id: actionlint-docker

.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,8 @@
+# Changelog
+
+## [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
@@ -60,7 +60,7 @@ You can install *Py Healthchecks.Io* via pip_ from PyPI_:
 
 .. code:: console
 
-   $ pip install py-healthchecks.io
+   $ pip install healthchecks-io
 
 
 Usage

bandit.yml

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

docs/conf.py

@@ -8,7 +8,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==2022.12.7
+sphinx==6.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
@@ -57,6 +82,7 @@ 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
 
+    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")
-    print(check)
+
+        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

@@ -7,6 +7,7 @@ from pathlib import Path
 from textwrap import dedent
 
 import nox
+import toml
 
 try:
     from nox_poetry import Session
@@ -22,7 +23,7 @@ except ImportError:
 
 
 package = "healthchecks_io"
-python_versions = ["3.10", "3.9", "3.8", "3.7"]
+python_versions = ["3.10", "3.11", "3.9", "3.8", "3.7"]
 nox.needs_version = ">= 2021.6.6"
 nox.options.sessions = (
     "pre-commit",
@@ -43,6 +44,9 @@ test_requirements = (
     "pytest-asyncio",
     "pytest-lazy-fixture",
 )
+mypy_type_packages = ()
+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 +65,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 +102,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()
@@ -142,7 +142,9 @@ 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
+    session.run("safety", "check", "--full-report", f"--file={requirements}", "--ignore=51457")
 
 
 @session(python=python_versions)
@@ -167,32 +169,7 @@ 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.0"
 description = "A python client package for Healthchecks.io API"
 authors = ["Andrew Herrington <andrew.the.techie@gmail.com>"]
 license = "MIT"
@@ -9,7 +9,16 @@ 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]
@@ -17,44 +26,34 @@ 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"
+pydantic = "^1.9.1"
+httpx = ">=0.23.0,<0.24.0"
 croniter = "^1.1.0"
-pytz = "^2021.3"
+pytz = ">=2021.3,<2023.0"
 
-[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"
+coverage = {extras = ["toml"], version = "^7.1"}
+safety = "^2.3.5"
+mypy = "^1.0"
+xdoctest = {extras = ["colors"], version = "^1.1.1"}
+sphinx = "^4.3.2"
 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.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.0.0"
+types-croniter = "^1.3.2"
+types-pytz = "^2022.7.1"
+pytest-asyncio = "^0.20.3"
+respx = "^0.20.1"
+pytest-mock = "^3.10.0"
 pytest-lazy-fixture = "^0.6.3"
+pytest-xdist = "^3.2.0"
+ruff = "^0.0.249"
+bandit = "^1.7.4"
 
 [tool.coverage.paths]
 source = ["src", "*/site-packages"]
@@ -80,10 +79,9 @@ show_error_context = true
 requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning"]
 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 = "py37"

src/healthchecks_io/__init__.py

@@ -1,21 +1,25 @@
 """Py Healthchecks.Io."""
 # set by poetry-dynamic-versioning
-__version__ = "0.0.0"  # noqa: E402
+__version__ = "0.4.0"  # 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 +27,8 @@ __all__ = [
     "CheckNotFoundError",
     "HCAPIRateLimitError",
     "NonUniqueSlugError",
+    "WrongClientError",
+    "PingFailedError",
     "Check",
     "CheckCreate",
     "CheckUpdate",

src/healthchecks_io/client/__init__.py

@@ -1,5 +1,6 @@
 """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

@@ -83,7 +83,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

src/healthchecks_io/client/async_client.py

@@ -1,9 +1,11 @@
 """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 +42,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 +51,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 +93,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 +112,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 +137,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 +236,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 +260,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 +295,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 +306,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 +323,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 +341,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 +356,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 +377,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 +392,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 +411,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 +426,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 +446,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 +461,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,166 @@
+"""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,10 @@
 """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 +52,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 +90,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 +132,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 +156,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 +229,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 +251,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 +299,8 @@ 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 +315,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 +333,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 +348,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 +369,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 +384,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 +403,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 +418,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 +438,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 +453,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/checks.py

@@ -38,19 +38,18 @@ class Check(BaseModel):
     update_url: Optional[str]
     pause_url: Optional[str]
     channels: Optional[str]
-    timeout: int
+    timeout: Optional[int]
     uuid: Optional[str]
 
     @validator("uuid", always=True)
-    def validate_uuid(
-        cls, value: Optional[str], values: Dict[str, Any]  # noqa: B902
-    ) -> Optional[str]:
+    def validate_uuid(cls, value: Optional[str], values: Dict[str, Any]) -> 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
+            # 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))
             return path.name
@@ -65,11 +64,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 +80,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 "
@@ -147,9 +144,7 @@ class CheckCreate(BaseModel):
     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")
@@ -167,9 +162,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.",
@@ -243,9 +236,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"]

tests/client/test_abstract.py

@@ -10,7 +10,6 @@ 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):

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,42 @@ 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):
@@ -357,9 +392,9 @@ ping_test_parameters = [
 @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):
+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(
+    respx_mocker.post(channels_url).mock(
         return_value=Response(status_code=200, text="OK")
     )
     ping_method = getattr(tc, ping_method)

tests/client/test_check_trap.py

@@ -0,0 +1,93 @@
+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,39 @@ 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/")
@@ -325,7 +357,7 @@ 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(
+    respx_mocker.post(channels_url).mock(
         return_value=Response(status_code=200, text="OK")
     )
     ping_method = getattr(tc, ping_method)