wwvb 3.0.8__tar.gz → 4.0.0__tar.gz

{wwvb-3.0.8 → wwvb-4.0.0}/.github/workflows/codeql.yml

@@ -28,21 +28,21 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install Dependencies (python)
         run: pip3 install -r requirements-dev.txt
 
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
+        uses: github/codeql-action/init@v3
         with:
           languages: ${{ matrix.language }}
           queries: +security-and-quality
 
       - name: Autobuild
-        uses: github/codeql-action/autobuild@v2
+        uses: github/codeql-action/autobuild@v3
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2
+        uses: github/codeql-action/analyze@v3
         with:
           category: "/language:${{ matrix.language }}"

{wwvb-3.0.8 → wwvb-4.0.0}/.github/workflows/cron.yml

@@ -20,10 +20,10 @@ jobs:
         GITHUB_CONTEXT: ${{ toJson(github) }}
       run: echo "$GITHUB_CONTEXT"
 
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Set up Python 3.10
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: "3.10"
 

{wwvb-3.0.8 → wwvb-4.0.0}/.github/workflows/release.yml

@@ -18,10 +18,10 @@ jobs:
         GITHUB_CONTEXT: ${{ toJson(github) }}
       run: echo "$GITHUB_CONTEXT"
 
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: 3.9
 

{wwvb-3.0.8 → wwvb-4.0.0}/.github/workflows/test.yml

@@ -13,6 +13,22 @@ on:
     types: [rerequested]
 
 jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
+
+    - uses: actions/checkout@v4
+
+    - name: Install deps
+      run: python -mpip install -r requirements-dev.txt
+
+    - name: Build HTML docs
+      run: make html
+
   test:
     strategy:
       fail-fast: false
@@ -41,10 +57,10 @@ jobs:
 
     runs-on: ${{ matrix.os-version }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -62,18 +78,18 @@ jobs:
 
     - name: Upload Coverage as artifact
       if: always()
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
-        name: coverage for ${{ matrix.python-version }} on ${{ matrix.os-version }}
+        name: coverage for ${{ matrix.python-version }} on ${{ matrix.os-version }} ${{ matrix.coverage-core }}
         path: coverage.xml
 
   pre-commit:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: '3.x'
 

{wwvb-3.0.8 → wwvb-4.0.0}/.pre-commit-config.yaml

@@ -7,7 +7,7 @@ default_language_version:
 
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.5.0
+  rev: v4.6.0
   hooks:
   -   id: check-yaml
   -   id: end-of-file-fixer
@@ -15,12 +15,12 @@ repos:
   -   id: trailing-whitespace
       exclude: tests
 - repo: https://github.com/fsfe/reuse-tool
-  rev: v3.0.1
+  rev: v4.0.3
   hooks:
   - id: reuse
 - repo: https://github.com/astral-sh/ruff-pre-commit
   # Ruff version.
-  rev: v0.3.5
+  rev: v0.5.1
   hooks:
     # Run the linter.
     - id: ruff

{wwvb-3.0.8/src/wwvb.egg-info → wwvb-4.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wwvb
-Version: 3.0.8
+Version: 4.0.0
 Summary: Generate WWVB timecodes for any desired time
 Home-page: https://github.com/jepler/wwvbpy
 Author: Jeff Epler

{wwvb-3.0.8 → wwvb-4.0.0}/adafruit_datetime.pyi

@@ -2,6 +2,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+# ruff: noqa
 import sys
 from time import struct_time
 from typing import (

{wwvb-3.0.8 → wwvb-4.0.0}/conf.py

@@ -1,3 +1,4 @@
+# ruff: noqa
 # fmt: off
 # Configuration file for the Sphinx documentation builder.
 #
@@ -16,14 +17,14 @@ import re
 import subprocess
 import sys
 
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath("."))
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'wwvb'
-copyright = '2021, Jeff Epler'
-author = 'Jeff Epler'
+project = "wwvb"
+copyright = "2021, Jeff Epler"
+author = "Jeff Epler"
 
 # The full version, including alpha/beta/rc tags
 final_version = ""
@@ -31,12 +32,12 @@ git_describe = subprocess.run(
     ["git", "describe", "--tags", "--dirty"],
     stdout=subprocess.PIPE,
     stderr=subprocess.STDOUT,
-    encoding="utf-8"
+    encoding="utf-8", check=False,
 )
 if git_describe.returncode == 0:
     git_version = re.search(
         r"^\d(?:\.\d){0,2}(?:\-(?:alpha|beta|rc)\.\d+){0,1}",
-        str(git_describe.stdout)
+        str(git_describe.stdout),
     )
     if git_version:
         final_version = git_version[0]
@@ -52,16 +53,16 @@ version = release = final_version
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
+    "sphinx.ext.autodoc",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 
 # -- Options for HTML output -------------------------------------------------
@@ -69,12 +70,12 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 autodoc_typehints = "description"
 autodoc_class_signature = "separated"

wwvb-4.0.0/index.rst

@@ -0,0 +1,31 @@
+.. SPDX-FileCopyrightText: 2021 Jeff Epler
+..
+.. SPDX-License-Identifier: GPL-3.0-only
+
+wwvbpy
+======
+
+.. image:: https://github.com/jepler/wwvbpy/actions/workflows/test.yml/badge.svg
+    :target: https://github.com/jepler/wwvbpy/actions/workflows/test.yml
+    :alt: Test wwvbpy
+
+.. image:: https://img.shields.io/pypi/v/wwvb
+    :target: https://pypi.org/project/wwvb
+    :alt: PyPI
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+wwvb module
+===========
+
+.. automodule:: wwvb
+   :members:
+
+uwwvb module
+============
+
+.. automodule:: uwwvb
+   :members:

{wwvb-3.0.8 → wwvb-4.0.0}/pyproject.toml

@@ -19,7 +19,7 @@ build-backend = "setuptools.build_meta"
 [tool.setuptools_scm]
 write_to = "src/wwvb/__version__.py"
 [tool.ruff.lint]
-select = ["E", "F"]
-ignore = ["E741"]
+select = ["E", "F", "D", "I", "N", "UP", "YTT", "BLE", "B", "FBT", "A", "COM", "C4", "DTZ", "FA", "ISC", "ICN", "PIE", "PYI", "Q", "RET", "SIM", "TID", "TCH", "ARG", "PTH", "C", "R", "W", "FLY", "RUF", "PL"]
+ignore = ["D203", "D213", "D400", "D415", "ISC001", "E741", "C901", "PLR0911", "PLR2004", "PLR0913"]
 [tool.ruff]
 line-length = 120

{wwvb-3.0.8 → wwvb-4.0.0}/requirements-dev.txt

@@ -14,6 +14,9 @@ pre-commit
 python-dateutil
 requests; implementation_name=="cpython"
 setuptools>=68; implementation_name=="cpython"
+sphinx
+sphinx-autodoc-typehints
+sphinx-rtd-theme
 twine; implementation_name=="cpython"
 types-beautifulsoup4
 types-python-dateutil

{wwvb-3.0.8 → wwvb-4.0.0}/src/uwwvb.py

@@ -2,6 +2,8 @@
 #
 # SPDX-License-Identifier: GPL-3.0-only
 
+# ruff: noqa: C405 PYI024 PLR2004 FBT001 FBT002
+
 """Implementation of a WWVB state machine & decoder for resource-constrained systems"""
 
 from __future__ import annotations
@@ -30,7 +32,8 @@ class WWVBDecoder:
     def update(self, value: int) -> list[int] | None:
         """Update the _state machine when a new symbol is received.
 
-        If a possible complete _minute is received, return it; otherwise, return None"""
+        If a possible complete _minute is received, return it; otherwise, return None
+        """
         result = None
         if self.state == 1:
             self.minute = []