wyzeapy 0.5.29__tar.gz → 0.5.31__tar.gz

{wyzeapy-0.5.29 → wyzeapy-0.5.31}/.github/CODEOWNERS

@@ -1,8 +1,8 @@
-# Lines starting with ‘#’ are comments.
+# Lines starting with '#' are comments.
 # Each line is a file pattern followed by one or more owners.
 
 # These owners will be the default owners for everything in the repo.
-*       @JoshuaMulliken
+*       @SecKatie
 
 # Order is important. The last matching pattern has the most precedence.
 # So if a pull request only touches javascript files, only these owners
@@ -10,4 +10,4 @@
 # *.js    @octocat @github/js
 
 # You can also use email addresses if you prefer.
-# docs/*  docs@example.com
+# docs/*  docs@example.com

wyzeapy-0.5.31/.github/workflows/auto-approve.yml

@@ -0,0 +1,19 @@
+name: Auto Approve Owner PRs
+
+on:
+  pull_request_target:
+    types: [opened, synchronize, reopened]
+
+permissions:
+  pull-requests: write
+
+jobs:
+  auto-approve:
+    runs-on: ubuntu-latest
+    # Only auto-approve PRs from the repository owner
+    if: github.event.pull_request.user.login == github.repository_owner
+    steps:
+      - name: Auto Approve
+        uses: hmarr/auto-approve-action@8f929096a962e83ccdfa8afcf855f39f12d4dac7 # v4
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

wyzeapy-0.5.31/.github/workflows/auto-assign.yml

@@ -0,0 +1,25 @@
+name: Auto Assign Issues
+
+on:
+  issues:
+    types: [opened]
+
+permissions:
+  contents: read
+
+jobs:
+  assign:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+    steps:
+      - name: Assign issue to SecKatie
+        uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
+        with:
+          script: |
+            await github.rest.issues.addAssignees({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.issue.number,
+              assignees: ['SecKatie']
+            });

{wyzeapy-0.5.29 → wyzeapy-0.5.31}/.github/workflows/codeql.yml

@@ -11,6 +11,9 @@ on:
   schedule:
     - cron: '0 0 * * *'
 
+permissions:
+  contents: read
+
 jobs:
   analyze:
     name: Analyze
@@ -28,21 +31,23 @@ jobs:
 
     strategy:
       fail-fast: false
-      
+      matrix:
+        language: [ 'python' ]
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v3
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@4e828ff8d448a8a6e532957b1811f387a63867e8 # v3
-        
+        uses: github/codeql-action/init@5d4e8d1aca955e8d8589aabd499c5cae939e33c7 # v4
+        with:
+          languages: ${{ matrix.language }}
 
       # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
       # If this step fails, then you should remove it and run the build manually (see below)
       - name: Autobuild
-        uses: github/codeql-action/autobuild@4e828ff8d448a8a6e532957b1811f387a63867e8 # v3
+        uses: github/codeql-action/autobuild@5d4e8d1aca955e8d8589aabd499c5cae939e33c7 # v4
 
       # Command-line programs to run using the OS shell.
       # See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -55,5 +60,6 @@ jobs:
       #     ./location_of_script_within_repo/buildscript.sh
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@4e828ff8d448a8a6e532957b1811f387a63867e8 # v3
-        
+        uses: github/codeql-action/analyze@5d4e8d1aca955e8d8589aabd499c5cae939e33c7 # v4
+        with:
+          category: "/language:${{matrix.language}}"

{wyzeapy-0.5.29 → wyzeapy-0.5.31}/.github/workflows/lint.yml

@@ -6,20 +6,23 @@ on:
   pull_request:
     branches: [ main, develop ]
 
+permissions:
+  contents: read
+
 jobs:
   lint:
     runs-on: ubuntu-latest
     
     steps:
-    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+    - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v4
     
     - name: Set up Python
-      uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
+      uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v5
       with:
         python-version: '3.11'
     
     - name: Install uv
-      uses: astral-sh/setup-uv@e92bafb6253dcd438e0484186d7669ea7a8ca1cc # v6.4.3
+      uses: astral-sh/setup-uv@61cb8a9741eeb8a550a1b8544337180c0fc8476b # v7.2.0
     
     - name: Install dependencies
       run: |

{wyzeapy-0.5.29 → wyzeapy-0.5.31}/.github/workflows/pre-release.yml

@@ -5,19 +5,22 @@ on:
     branches:
       - release/*
 
+permissions:
+  contents: read
+
 jobs:
   test-publish:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v4
 
-      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
+      - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v5
         with:
           python-version: "3.12"
 
       - name: Install uv
-        uses: astral-sh/setup-uv@e92bafb6253dcd438e0484186d7669ea7a8ca1cc # v4
+        uses: astral-sh/setup-uv@61cb8a9741eeb8a550a1b8544337180c0fc8476b # v4
         with:
           enable-cache: true
 

wyzeapy-0.5.31/.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write  # Required for trusted publishing
+
+    steps:
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v4
+
+      - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v5
+        with:
+          python-version: "3.12"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@61cb8a9741eeb8a550a1b8544337180c0fc8476b # v4
+        with:
+          enable-cache: true
+
+      - name: Build distribution
+        run: uv build
+
+      - name: Publish package to PyPI
+        run: uv publish

wyzeapy-0.5.31/.github/workflows/scorecard.yml

@@ -0,0 +1,78 @@
+# This workflow uses actions that are not certified by GitHub. They are provided
+# by a third-party and are governed by separate terms of service, privacy
+# policy, and support documentation.
+
+name: Scorecard supply-chain security
+on:
+  # For Branch-Protection check. Only the default branch is supported. See
+  # https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
+  branch_protection_rule:
+  # To guarantee Maintained check is occasionally updated. See
+  # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
+  schedule:
+    - cron: '29 2 * * 4'
+  push:
+    branches: [ "main" ]
+
+# Declare default permissions as read only.
+permissions: read-all
+
+jobs:
+  analysis:
+    name: Scorecard analysis
+    runs-on: ubuntu-latest
+    # `publish_results: true` only works when run from the default branch. conditional can be removed if disabled.
+    if: github.event.repository.default_branch == github.ref_name || github.event_name == 'pull_request'
+    permissions:
+      # Needed to upload the results to code-scanning dashboard.
+      security-events: write
+      # Needed to publish results and get a badge (see publish_results below).
+      id-token: write
+      # Uncomment the permissions below if installing in a private repository.
+      # contents: read
+      # actions: read
+
+    steps:
+      - name: "Checkout code"
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+        with:
+          persist-credentials: false
+
+      - name: "Run analysis"
+        uses: ossf/scorecard-action@4eaacf0543bb3f2c246792bd56e8cdeffafb205a # v2.4.3
+        with:
+          results_file: results.sarif
+          results_format: sarif
+          # (Optional) "write" PAT token. Uncomment the `repo_token` line below if:
+          # - you want to enable the Branch-Protection check on a *public* repository, or
+          # - you are installing Scorecard on a *private* repository
+          # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action?tab=readme-ov-file#authentication-with-fine-grained-pat-optional.
+          # repo_token: ${{ secrets.SCORECARD_TOKEN }}
+
+          # Public repositories:
+          #   - Publish results to OpenSSF REST API for easy access by consumers
+          #   - Allows the repository to include the Scorecard badge.
+          #   - See https://github.com/ossf/scorecard-action#publishing-results.
+          # For private repositories:
+          #   - `publish_results` will always be set to `false`, regardless
+          #     of the value entered here.
+          publish_results: true
+
+          # (Optional) Uncomment file_mode if you have a .gitattributes with files marked export-ignore
+          # file_mode: git
+
+      # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
+      # format to the repository Actions tab.
+      - name: "Upload artifact"
+        uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
+        with:
+          name: SARIF file
+          path: results.sarif
+          retention-days: 5
+
+      # Upload the results to GitHub's code scanning dashboard (optional).
+      # Commenting out will disable upload of results to your repo's Code Scanning dashboard
+      - name: "Upload to code-scanning"
+        uses: github/codeql-action/upload-sarif@5d4e8d1aca955e8d8589aabd499c5cae939e33c7 # v4
+        with:
+          sarif_file: results.sarif

{wyzeapy-0.5.29 → wyzeapy-0.5.31}/.github/workflows/test.yml

@@ -6,6 +6,9 @@ on:
   pull_request:
     branches: [ main, develop ]
 
+permissions:
+  contents: read
+
 jobs:
   test:
     runs-on: ubuntu-latest
@@ -14,15 +17,15 @@ jobs:
         python-version: ['3.11', '3.12']
     
     steps:
-    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+    - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v4
     
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
+      uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v5
       with:
         python-version: ${{ matrix.python-version }}
     
     - name: Install uv
-      uses: astral-sh/setup-uv@e92bafb6253dcd438e0484186d7669ea7a8ca1cc # v6.4.3
+      uses: astral-sh/setup-uv@61cb8a9741eeb8a550a1b8544337180c0fc8476b # v7.2.0
     
     - name: Install dependencies
       run: |
@@ -39,7 +42,7 @@ jobs:
         coverage xml
     
     - name: Upload coverage reports to Codecov
-      uses: codecov/codecov-action@18283e04ce6e62d37312384ff67231eb8fd56d24 # v4
+      uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de # v4
       if: matrix.python-version == '3.11'
       with:
         file: ./coverage.xml

{wyzeapy-0.5.29 → wyzeapy-0.5.31}/.gitignore

@@ -41,3 +41,4 @@ build/
 # OS
 .DS_Store
 Thumbs.db
+.envrc

wyzeapy-0.5.31/.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+repos:
+- repo: https://github.com/gitleaks/gitleaks
+  rev: v8.16.3
+  hooks:
+  - id: gitleaks
+- repo: https://github.com/jumanjihouse/pre-commit-hooks
+  rev: 3.0.0
+  hooks:
+  - id: shellcheck
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.4.0
+  hooks:
+  - id: end-of-file-fixer
+  - id: trailing-whitespace
+- repo: https://github.com/pylint-dev/pylint
+  rev: v2.17.2
+  hooks:
+  - id: pylint

{wyzeapy-0.5.29 → wyzeapy-0.5.31}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: wyzeapy
-Version: 0.5.29
+Version: 0.5.31
 Summary: A library for interacting with Wyze devices
 Author-email: Katie Mulliken <katie@mulliken.net>
 License: GPL-3.0-only
 Requires-Python: >=3.11.0
-Requires-Dist: aiodns<4.0.0,>=3.2.0
+Requires-Dist: aiodns<5.0.0,>=3.2.0
 Requires-Dist: aiohttp<4.0.0,>=3.11.12
 Requires-Dist: pycryptodome<4.0.0,>=3.21.0
 Provides-Extra: dev
-Requires-Dist: pdoc<16.0.0,>=15.0.3; extra == 'dev'
-Requires-Dist: pytest<9.0.0,>=7.0.0; extra == 'dev'
+Requires-Dist: pdoc<17.0.0,>=15.0.3; extra == 'dev'
+Requires-Dist: pytest<10.0.0,>=7.0.0; extra == 'dev'

{wyzeapy-0.5.29 → wyzeapy-0.5.31}/README.md

@@ -23,13 +23,13 @@ from wyzeapy import Wyzeapy
 
 async def async_main():
     client = await Wyzeapy.create()
-    await client.login("EMAIL", "PASSWORD")
+    await client.login(email="EMAIL", password="PASSWORD", key_id="KEY_ID", api_key="API_KEY")
 
 
 if __name__ == "__main__":
-    loop = asyncio.get_event_loop()
-    loop.run_until_complete(async_main())
+    asyncio.run(async_main())
 ```
+Note: Visit the [Wyze developer console](https://developer-api-console.wyze.com/#/apikey/view) to generate an Key Id and Api Key.
 
 ## Thanks to:
 

wyzeapy-0.5.31/SECURITY.md

@@ -0,0 +1,79 @@
+# Security Policy
+
+## Supported Versions
+
+The following versions of Wyzeapy are currently supported with security updates:
+
+| Version | Supported          |
+| ------- | ------------------ |
+| Latest  | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+We take the security of Wyzeapy seriously. If you believe you have found a security vulnerability in this project, please report it to us responsibly.
+
+### How to Report
+
+**Please do not report security vulnerabilities through public GitHub issues.**
+
+Instead, please use one of the following methods:
+
+1. **GitHub Private Vulnerability Reporting (Preferred):** Use GitHub's [private vulnerability reporting feature](https://github.com/SecKatie/wyzeapy/security/advisories/new) to submit your report directly through the repository.
+
+2. **Email:** Send an email to [katie@mulliken.net](mailto:katie@mulliken.net) with the subject line "Wyzeapy Security Vulnerability Report".
+
+### What to Include
+
+Please include the following information in your report:
+
+- A clear description of the vulnerability
+- Steps to reproduce the issue
+- Affected versions
+- Potential impact of the vulnerability
+- Any suggested fixes or mitigations (optional)
+
+### What to Expect
+
+After you submit a vulnerability report:
+
+1. **Acknowledgment:** You will receive an acknowledgment of your report within 48 hours.
+
+2. **Initial Assessment:** Within 7 days, we will provide an initial assessment of the vulnerability and an estimated timeline for a fix.
+
+3. **Resolution Timeline:** We aim to resolve critical vulnerabilities within 30 days and other vulnerabilities within 90 days of the initial report.
+
+4. **Disclosure:** We follow coordinated vulnerability disclosure practices. We will work with you to determine an appropriate disclosure timeline once a fix is available.
+
+5. **Credit:** If you would like to be credited for the discovery, please let us know how you would like to be acknowledged.
+
+### Scope
+
+The following are considered in-scope for security vulnerability reports:
+
+- Authentication and authorization issues
+- Credential exposure or leakage
+- Injection vulnerabilities
+- Sensitive data exposure
+- Security misconfigurations in the library code
+
+The following are generally out of scope:
+
+- Issues in third-party dependencies (please report these to the respective maintainers)
+- Issues related to the Wyze API itself (please report these to Wyze)
+- Social engineering attacks
+- Denial of service attacks
+
+## Security Best Practices for Users
+
+When using Wyzeapy:
+
+- Never commit credentials or API keys to version control
+- Store sensitive configuration in environment variables or secure vaults
+- Keep the library updated to the latest version
+- Review the permissions and scopes requested by your integration
+
+## Contact
+
+For security-related inquiries, contact: [katie@mulliken.net](mailto:katie@mulliken.net)
+
+For general questions and non-security issues, please use [GitHub Issues](https://github.com/SecKatie/wyzeapy/issues).

{wyzeapy-0.5.29 → wyzeapy-0.5.31}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "wyzeapy"
-version = "0.5.29"
+version = "0.5.31"
 description = "A library for interacting with Wyze devices"
 authors = [
     { name = "Katie Mulliken", email = "katie@mulliken.net" },
@@ -9,14 +9,14 @@ license = { text = "GPL-3.0-only" }
 requires-python = ">=3.11.0"
 dependencies = [
     "aiohttp>=3.11.12,<4.0.0",
-    "aiodns>=3.2.0,<4.0.0",
+    "aiodns>=3.2.0,<5.0.0",
     "pycryptodome>=3.21.0,<4.0.0",
 ]
 
 [project.optional-dependencies]
 dev = [
-    "pdoc>=15.0.3,<16.0.0",
-    "pytest>=7.0.0,<9.0.0",
+    "pdoc>=15.0.3,<17.0.0",
+    "pytest>=7.0.0,<10.0.0",
 ]
 
 [build-system]
@@ -26,6 +26,6 @@ build-backend = "hatchling.build"
 [dependency-groups]
 dev = [
     "ruff>=0.12.3",
-    "pytest>=7.0.0,<9.0.0",
+    "pytest>=7.0.0,<10.0.0",
     "coverage>=7.9.2",
 ]

{wyzeapy-0.5.29 → wyzeapy-0.5.31}/src/wyzeapy/__init__.py

@@ -16,6 +16,7 @@ from .services.lock_service import LockService
 from .services.sensor_service import SensorService
 from .services.switch_service import SwitchService, SwitchUsageService
 from .services.thermostat_service import ThermostatService
+from .services.irrigation_service import IrrigationService
 from .services.wall_switch_service import WallSwitchService
 from .wyze_auth_lib import WyzeAuthLib, Token
 
@@ -50,6 +51,7 @@ class Wyzeapy:
         self._hms_service = None
         self._lock_service = None
         self._sensor_service = None
+        self._irrigation_service = None
         self._wall_switch_service = None
         self._switch_usage_service = None
         self._email = None
@@ -442,6 +444,14 @@ class Wyzeapy:
             self._sensor_service = SensorService(self._auth_lib)
         return self._sensor_service
 
+    @property
+    async def irrigation_service(self) -> IrrigationService:
+        """Returns an instance of the irrigation service"""
+
+        if self._irrigation_service is None:
+            self._irrigation_service = IrrigationService(self._auth_lib)
+        return self._irrigation_service
+
     @property
     async def wall_switch_service(self) -> WallSwitchService:
         """Provides access to the Wyze Wall Switch service.

{wyzeapy-0.5.29 → wyzeapy-0.5.31}/src/wyzeapy/payload_factory.py

@@ -52,6 +52,40 @@ def olive_create_get_payload(device_mac: str, keys: str) -> Dict[str, Any]:
     return {"keys": keys, "did": device_mac, "nonce": nonce}
 
 
+def olive_create_get_payload_irrigation(device_mac: str) -> Dict[str, Any]:
+    nonce = int(time.time() * 1000)
+
+    return {"device_id": device_mac, "nonce": str(nonce)}
+
+
+def olive_create_post_payload_irrigation_stop(
+    device_mac: str, action: str
+) -> Dict[str, Any]:
+    nonce = int(time.time() * 1000)
+
+    return {"device_id": device_mac, "nonce": str(nonce), "action": action}
+
+
+def olive_create_post_payload_irrigation_quickrun(
+    device_mac: str, zone_number: int, duration: int
+) -> Dict[str, Any]:
+    nonce = int(time.time() * 1000)
+
+    return {
+        "device_id": device_mac,
+        "nonce": str(nonce),
+        "zone_runs": [{"zone_number": zone_number, "duration": duration}],
+    }
+
+
+def olive_create_get_payload_irrigation_schedule_runs(
+    device_mac: str,
+) -> Dict[str, Any]:
+    nonce = int(time.time() * 1000)
+
+    return {"device_id": device_mac, "nonce": str(nonce)}
+
+
 def olive_create_post_payload(
     device_mac: str, device_model: str, prop_key: str, value: Any
 ) -> Dict[str, Any]: