Release 0.4.5

.github/workflows/python-app.yml

@@ -45,7 +45,7 @@ jobs:
     - name: Install project
       run: |
         python -m pip install --upgrade pip
-        pip install ".[dev]"
+        pip install ".[dev,docs]"
 
     - name: Check formatting with black
       run: black --check .

.github/workflows/python-binary.yml

@@ -0,0 +1,124 @@
+name: Python Binary
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  binary-build:
+    name: Build ${{ matrix.asset_name }}
+    runs-on: ${{ matrix.runner }}
+
+    permissions:
+      contents: write
+
+    strategy:
+      fail-fast: true
+      matrix:
+        include:
+          - runner: ubuntu-26.04
+            python_arch: x64
+            asset_name: onvif-linux-amd64
+            executable_name: onvif
+
+          - runner: ubuntu-26.04
+            python_arch: x86
+            asset_name: onvif-linux-i386
+            executable_name: onvif
+
+          - runner: ubuntu-26.04-arm
+            python_arch: arm64
+            asset_name: onvif-linux-arm64
+            executable_name: onvif
+
+          - runner: windows-latest
+            python_arch: x64
+            asset_name: onvif-windows-win64
+            executable_name: onvif.exe
+
+          - runner: windows-latest
+            python_arch: x86
+            asset_name: onvif-windows-win32
+            executable_name: onvif.exe
+
+          - runner: windows-11-arm
+            python_arch: arm64
+            asset_name: onvif-windows-arm64
+            executable_name: onvif.exe
+
+          - runner: macos-15-intel
+            python_arch: x64
+            asset_name: onvif-macos-amd64
+            executable_name: onvif
+
+          - runner: macos-latest
+            python_arch: arm64
+            asset_name: onvif-macos-arm64
+            executable_name: onvif
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+
+      - name: Set up Python
+        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: "3.13"
+          architecture: ${{ matrix.python_arch }}
+
+      - name: Verify Python architecture ${{ matrix.python_arch }} | ${{ matrix.runner }}
+        env:
+          EXPECTED_ARCH: ${{ matrix.python_arch }}
+        run: |
+          python -c "import os, platform, struct, sys; actual = struct.calcsize('P') * 8; expected = {'x86': 32, 'x64': 64, 'arm64': 64}[os.environ['EXPECTED_ARCH']]; print(f'Python: {platform.python_version()}'); print(f'Architecture: {platform.machine()} ({actual}-bit)'); sys.exit(0 if actual == expected else f'Expected {expected}-bit Python, got {actual}-bit')"
+
+      - name: Install project and PyInstaller ${{ matrix.python_arch }} | ${{ matrix.runner }}
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install . pyinstaller pillow
+
+      - name: Build executable (${{ matrix.asset_name }})
+        run: >
+          pyinstaller
+          --clean
+          --noconfirm
+          --onedir
+          --collect-all onvif
+          --icon docs/assets/onvif.png
+          --name onvif
+          onvif/cli/__main__.py
+
+      - name: Include license and notice (${{ matrix.asset_name }})
+        shell: bash
+        run: |
+          cp LICENSE dist/onvif/LICENSE
+          if [ -f NOTICE ]; then
+            cp NOTICE dist/onvif/NOTICE
+          fi
+
+      - name: Test executable (${{ matrix.asset_name }})
+        env:
+          EXECUTABLE_NAME: ${{ matrix.executable_name }}
+        run: |
+          python -c "import os, subprocess; from pathlib import Path; p = (Path('dist/onvif') / os.environ['EXECUTABLE_NAME']).resolve(); print(f'Testing: {p}'); result = subprocess.run([str(p), '--help'], capture_output=True, text=True, timeout=60); print(result.stdout); print(result.stderr); raise SystemExit(result.returncode)"
+
+      - name: Package distribution (${{ matrix.asset_name }})
+        env:
+          ASSET_NAME: ${{ matrix.asset_name }}
+        run: |
+          python -c "import os, shutil; from pathlib import Path; src = Path('dist/onvif'); dst = Path('dist') / os.environ['ASSET_NAME']; shutil.make_archive(str(dst), 'zip', root_dir=src.parent, base_dir=src.name); print(f'Created {dst}.zip')"
+
+      - name: Verify archive (${{ matrix.asset_name }})
+        env:
+          ASSET_NAME: ${{ matrix.asset_name }}
+        run: |
+          python -c "import os, sys, zipfile; from pathlib import Path; p = Path('dist') / (os.environ['ASSET_NAME'] + '.zip'); valid = p.is_file() and p.stat().st_size > 0 and zipfile.is_zipfile(p); print(f'Archive: {p} ({p.stat().st_size if p.exists() else 0} bytes)'); sys.exit(0 if valid else f'Invalid archive: {p}')"
+
+      - name: Upload to GitHub Release (${{ matrix.asset_name }})
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: gh release upload "$GITHUB_REF_NAME" "dist/${{ matrix.asset_name }}.zip" --clobber
+        shell: bash

.github/workflows/python-publish.yml

@@ -24,6 +24,85 @@ jobs:
           python -m pip install build
           python -m build
 
+      - name: Verify WSDL files are included
+        run: |
+          python - <<'PY'
+          import sys
+          import zipfile
+          from pathlib import Path
+
+          expected = {
+              path.relative_to(".").as_posix()
+              for path in Path("onvif/wsdl").rglob("*.wsdl")
+          }
+
+          wheels = list(Path("dist").glob("*.whl"))
+
+          if not wheels:
+              print("ERROR: No wheel was produced.")
+              sys.exit(1)
+
+          for wheel in wheels:
+              with zipfile.ZipFile(wheel) as archive:
+                  included = set(archive.namelist())
+
+              missing = expected - included
+
+              if missing:
+                  print(f"ERROR: Missing WSDL files in {wheel.name}:")
+                  for path in sorted(missing):
+                      print(f"  - {path}")
+                  sys.exit(1)
+
+              print(
+                  f"{wheel.name}: all {len(expected)} WSDL files are included."
+              )
+
+          print("WSDL package contents verified successfully.")
+          PY
+
+      - name: Verify database files are included
+        run: |
+          python - <<'PY'
+          import sys
+          import zipfile
+          from pathlib import Path
+
+          expected = {
+              path.relative_to(".").as_posix()
+              for path in Path("onvif/db").rglob("*.db")
+          }
+
+          wheels = list(Path("dist").glob("*.whl"))
+
+          if not wheels:
+              print("ERROR: No wheel was produced.")
+              sys.exit(1)
+
+          if not expected:
+              print("ERROR: No database files found in onvif/db.")
+              sys.exit(1)
+
+          for wheel in wheels:
+              with zipfile.ZipFile(wheel) as archive:
+                  included = set(archive.namelist())
+
+              missing = expected - included
+
+              if missing:
+                  print(f"ERROR: Missing database files in {wheel.name}:")
+                  for path in sorted(missing):
+                      print(f"  - {path}")
+                  sys.exit(1)
+
+              print(
+                  f"{wheel.name}: all {len(expected)} "
+                  f"database files are included."
+              )
+
+          print("Database package contents verified successfully.")
+          PY
+
       - name: Upload distributions
         uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a  # v7.0.1
         with:

CONTRIBUTING.md

@@ -12,4 +12,4 @@ Your feedback, code, documentation, and ideas help make this project better for
 
 ## How to contribute?
 
-Please check the [Contributing](https://nirsimetri.github.io/onvif-python/project/contributing) guide page, that page explains step-by-step how to contribute to the project correctly.
+Please check the [Contributing Guide](https://onvif-python.pages.dev/project/contributing) page, that page explains step-by-step how to contribute to the project correctly.

NOTICE

@@ -1,11 +1,20 @@
-This project is an independent open-source implementation of the ONVIF (https://www.onvif.org) specifications. It is not affiliated with, endorsed by, or sponsored by ONVIF or its member companies.
+This project is an independent open-source implementation of the
+ONVIF (https://www.onvif.org) specifications. It is not affiliated with,
+endorsed by, or sponsored by ONVIF or its member companies.
 
-- The name “ONVIF” and the ONVIF logo are registered trademarks of the ONVIF organization.  
-- Any references to ONVIF within this project are made strictly for the purpose of describing interoperability with ONVIF-compliant devices and services.  
-- Use of the ONVIF trademark in this repository is solely nominative and does not imply any partnership, certification, or official status.
+- The name “ONVIF” is a registered trademarks of the ONVIF organization.
+- Any references to ONVIF within this project are made strictly for the purpose of
+    describing interoperability with ONVIF-compliant devices and services.  
+- Use of the ONVIF trademark in this repository is solely nominative and does not imply
+    any partnership, certification, or official status.
 - This project includes WSDL/XSD/HTML files from the official ONVIF specifications.
 - These files are © ONVIF and are redistributed here for interoperability purposes.
-- The WSDL files in the https://github.com/nirsimetri/onvif-python/tree/main/onvif/wsdl folder are distributed under the ONVIF Contributor License Agreement and Apache License 2.0. See https://github.com/nirsimetri/onvif-python/tree/main/onvif/wsdl/LICENSE for details.
+- The WSDL files in the https://github.com/nirsimetri/onvif-python/tree/main/onvif/wsdl
+    folder are distributed under the Apache License 2.0. See
+    https://github.com/nirsimetri/onvif-python/tree/main/onvif/wsdl/LICENSE for details.
 - All rights to the ONVIF specifications are reserved by ONVIF.
 
-If you require certified ONVIF-compliant devices or clients, please refer to the official https://www.onvif.org/conformant-products. For authoritative reference and the latest official ONVIF specifications, please consult the https://www.onvif.org/profiles/specifications/specification-history.
+If you require certified ONVIF-compliant devices or clients, please refer to
+the official https://www.onvif.org/conformant-products. For authoritative
+reference and the latest official ONVIF specifications, please consult the
+https://www.onvif.org/profiles/specifications/specification-history.