chore: poetry update (#188)

This updates pyupgrade, safety, and types-pytz to their most recent
versions

.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,6 @@
-pip==21.3.1
-nox==2021.10.1
-nox-poetry==0.9.0
-poetry==1.1.12
-virtualenv==20.11.2
-poetry-dynamic-versioning==0.13.1
+pip==22.1.2
+nox==2022.1.7
+nox-poetry==1.0.1
+poetry==1.1.14
+virtualenv==20.15.1
+poetry-dynamic-versioning==0.17.1

.github/workflows/labeler.yml

@@ -11,9 +11,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out the repository
-        uses: actions/checkout@v2.4.0
+        uses: actions/checkout@v3
 
       - name: Run Labeler
-        uses: crazy-max/ghaction-github-labeler@v3.1.1
+        uses: crazy-max/ghaction-github-labeler@v4.0.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@v3
         with:
           fetch-depth: 2
 
       - name: Set up Python
-        uses: actions/setup-python@v2.3.1
+        uses: actions/setup-python@v4.0.0
         with:
           python-version: "3.10"
 
@@ -35,7 +35,7 @@ jobs:
 
       - 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.5.0
         with:
           user: __token__
           password: ${{ secrets.TEST_PYPI_TOKEN }}

.github/workflows/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@v3
         with:
           fetch-depth: 2
 
       - name: Set up Python
-        uses: actions/setup-python@v2.3.1
+        uses: actions/setup-python@v4.0.0
         with:
           python-version: "3.10"
 
@@ -34,7 +34,7 @@ jobs:
           poetry build --ansi
 
       - name: Publish package on PyPI
-        uses: pypa/gh-action-pypi-publish@v1.4.2
+        uses: pypa/gh-action-pypi-publish@v1.5.0
         with:
           user: __token__
           password: ${{ secrets.PYPI_TOKEN }}

.github/workflows/tests.yml

@@ -35,10 +35,10 @@ jobs:
 
     steps:
       - name: Check out the repository
-        uses: actions/checkout@v2.4.0
+        uses: actions/checkout@v3
 
       - name: Set up Python ${{ matrix.python }}
-        uses: actions/setup-python@v2.3.1
+        uses: actions/setup-python@v4.0.0
         with:
           python-version: ${{ matrix.python }}
 
@@ -83,7 +83,7 @@ jobs:
           print("::set-output name=result::{}".format(result))
 
       - name: Restore pre-commit cache
-        uses: actions/cache@v2.1.7
+        uses: actions/cache@v3.0.4
         if: matrix.session == 'pre-commit'
         with:
           path: ~/.cache/pre-commit
@@ -97,14 +97,14 @@ jobs:
 
       - name: Upload coverage data
         if: always() && matrix.session == 'tests'
-        uses: "actions/upload-artifact@v2.3.1"
+        uses: "actions/upload-artifact@v3"
         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
         with:
           name: docs
           path: docs/_build
@@ -114,10 +114,10 @@ jobs:
     needs: tests
     steps:
       - name: Check out the repository
-        uses: actions/checkout@v2.4.0
+        uses: actions/checkout@v3
 
       - name: Set up Python
-        uses: actions/setup-python@v2.3.1
+        uses: actions/setup-python@v4.0.0
         with:
           python-version: "3.10"
 
@@ -138,7 +138,7 @@ jobs:
           nox --version
 
       - name: Download coverage data
-        uses: actions/download-artifact@v2.1.0
+        uses: actions/download-artifact@v3
         with:
           name: coverage-data
 
@@ -151,4 +151,4 @@ jobs:
           nox --force-color --session=coverage -- xml
 
       - name: Upload coverage report
-        uses: codecov/codecov-action@v2.1.0
+        uses: codecov/codecov-action@v3.1.0

.gitignore

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

.pre-commit-config.yaml

@@ -54,6 +54,6 @@ 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

.prettierignore

@@ -0,0 +1 @@
+.github/*

.vscode/settings.json

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

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.2
-sphinx-click==3.0.2
+furo==2022.6.21
+sphinx==5.0.2

docs/usage.rst

@@ -10,10 +10,10 @@ Either the Client or AsyncClient can be used as a ContextManager (or Async Conte
 
 .. code-block:: python
 
-    from healthchecks_io import AsyncClient, CheckCreate
+    from healthchecks_io import Client, CheckCreate
 
-    async with AsyncClient(api_key="myapikey") as client:
-        check = await client.create_check(CreateCheck(name="New Check", tags="tag1 tag2")
+    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
@@ -63,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
@@ -94,16 +94,19 @@ 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
 
-    client = AsyncClient(api_key="myapikey")
+    async def main():
+        client = AsyncClient(api_key="myapikey")
 
-    check = await client.create_check(CreateCheck(name="New Check", tags="tag1 tag2")
-    print(check)
+        check = await client.create_check(CheckCreate(name="New Check", tags="tag1 tag2"))
+        print(check)
+
+    if __name__ == "__main__":
+        asyncio.run(main())
 
 
 CheckTrap
@@ -115,28 +118,30 @@ That's what CheckTrap is for.
 
 .. code-block:: python
 
+    import asyncio
     from healthchecks_io import Client, AsyncClient, CheckCreate, CheckTrap
 
-    client = Client(api_key="myapikey")
+    def run_my_thing_to_monitor():
+        pass
 
-    # 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")
+    async def main(check):
+        client = AsyncClient(ping_key="ping_key")
 
-    with CheckTrap(client, check.uuid):
-        # when entering the context manager, sends a start ping to your check
-        run_my_thing_to_monitor()
+        # 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 your method exits without an exception, sends a success ping
-    # If there's an exception, a failure ping will be sent with the exception and traceback
+    if __name__ == "__main__":
+        client = Client(api_key="myapikey")
 
-    client = AsyncClient(ping_key="ping_key")
+        # 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")
 
-    # works with async too, and the ping api and slugs
-    with CheckTrap(client, 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()
+        with CheckTrap(client, check.uuid):
+            # when entering the context manager, sends a start ping to your check
+            run_my_thing_to_monitor()
 
-    # If your method exits without an exception, sends a success ping
-    # If there's an exception, a failure ping will be sent with the exception and traceback
+        asyncio.run(main())

pyproject.toml

@@ -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,43 +26,41 @@ 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"
+pytest = "^7.1.2"
+coverage = {extras = ["toml"], version = "^6.4"}
+safety = "^2.0.0"
+mypy = "^0.961"
 typeguard = "^2.13.2"
-xdoctest = {extras = ["colors"], version = "^0.15.10"}
+xdoctest = {extras = ["colors"], version = "^1.0.0"}
 sphinx = "^4.3.2"
 sphinx-autobuild = ">=2021.3.14"
-pre-commit = "^2.16.0"
+pre-commit = "^2.19.0"
 flake8 = "^4.0.1"
 black = ">=21.10b0"
-flake8-bandit = "^2.1.2"
+flake8-bandit = "^3.0.0"
 flake8-bugbear = ">=21.9.2"
 flake8-docstrings = "^1.6.0"
 flake8-rst-docstrings = "^0.2.3"
-pep8-naming = "^0.12.1"
+pep8-naming = "^0.13.0"
 darglint = "^1.8.1"
-reorder-python-imports = "^2.6.0"
-pre-commit-hooks = "^4.0.1"
-sphinx-click = "^3.0.2"
-Pygments = "^2.11.0"
-pyupgrade = "^2.30.0"
+reorder-python-imports = "^3.1.0"
+pre-commit-hooks = "^4.2.0"
+Pygments = "^2.12.0"
+pyupgrade = "^2.32.1"
 furo = ">=2021.11.12"
 pytest-cov = "^3.0.0"
-types-croniter = "^1.0.3"
-types-pytz = "^2021.3.3"
+types-croniter = "^1.0.10"
+types-pytz = "^2022.1.1"
 pytest_async = "^0.1.1"
-pytest-asyncio = "^0.16.0"
-respx = "^0.19.0"
-pytest-mock = "^3.6.1"
+pytest-asyncio = "^0.18.3"
+respx = "^0.19.2"
+pytest-mock = "^3.7.0"
 pytest-lazy-fixture = "^0.6.3"
 
 [tool.coverage.paths]

src/healthchecks_io/client/async_client.py

@@ -98,7 +98,7 @@ class AsyncClient(AbstractClient):
         """
         request_url = self._get_api_request_url("checks/")
         response = self.check_response(
-            await self._client.post(request_url, json=new_check.dict())
+            await self._client.post(request_url, json=new_check.dict(exclude_none=True))
         )
         return Check.from_api_result(response.json())
 
@@ -118,7 +118,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())

src/healthchecks_io/client/sync_client.py

@@ -138,7 +138,7 @@ class Client(AbstractClient):
         """
         request_url = self._get_api_request_url("checks/")
         response = self.check_response(
-            self._client.post(request_url, json=new_check.dict())
+            self._client.post(request_url, json=new_check.dict(exclude_none=True))
         )
         return Check.from_api_result(response.json())
 
@@ -163,7 +163,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())
 

src/healthchecks_io/schemas/checks.py

@@ -38,7 +38,7 @@ 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)
@@ -65,11 +65,11 @@ class Check(BaseModel):
 class CheckCreate(BaseModel):
     """Pydantic object for creating a check."""
 
-    name: Optional[str] = Field(..., description="Name of the check")
+    name: Optional[str] = Field("", description="Name of the check")
     tags: Optional[str] = Field(
-        ..., description="String separated list of tags to apply"
+        "", description="String separated list of tags to apply"
     )
-    desc: Optional[str] = Field(..., description="Description of the check")
+    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 +83,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 "