deebot-client 3.0.2__tar.gz → 4.0.0__tar.gz

deebot-client-4.0.0/.codecov.yml

@@ -0,0 +1,5 @@
+coverage:
+  status:
+    patch:
+      default:
+        target: 80%

deebot-client-4.0.0/.coveragerc

@@ -0,0 +1,11 @@
+[run]
+branch = True
+source = deebot_client
+
+omit =
+    tests/*
+
+[report]
+exclude_lines =
+    pragma: no cover
+    if TYPE_CHECKING:

deebot-client-4.0.0/.devcontainer.json

@@ -0,0 +1,73 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.177.0/containers/python-3
+{
+  "customizations": {
+    // Configure properties specific to VS Code.
+    "vscode": {
+      "extensions": [
+        "charliermarsh.ruff",
+        "eamodio.gitlens",
+        "github.vscode-pull-request-github",
+        "ms-python.python",
+        "ms-python.vscode-pylance",
+        "ms-vscode.makefile-tools",
+        "ryanluker.vscode-coverage-gutters",
+        "visualstudioexptteam.vscodeintellicode"
+      ],
+      // Set *default* container specific settings.json values on container create.
+      "settings": {
+        "[python]": {
+          "editor.defaultFormatter": "charliermarsh.ruff"
+        },
+        "editor.formatOnPaste": false,
+        "editor.formatOnSave": true,
+        "editor.formatOnType": true,
+        "editor.tabSize": 4,
+        "files.eol": "\n",
+        "files.trimTrailingWhitespace": true,
+        "python.analysis.autoImportCompletions": true,
+        "python.analysis.autoSearchPaths": false,
+        "python.analysis.extraPaths": ["/home/vscode/.local/lib/python3.11/"],
+        "python.analysis.typeCheckingMode": "basic",
+        "python.defaultInterpreterPath": "/usr/local/bin/python",
+        "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
+        "python.formatting.blackPath": "/usr/local/py-utils/bin/black",
+        "python.formatting.provider": "black",
+        "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
+        "python.languageServer": "Pylance",
+        "python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
+        "python.linting.enabled": true,
+        "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
+        "python.linting.mypyEnabled": true,
+        "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
+        "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
+        "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
+        "python.linting.pylintArgs": ["--disable", "import-error"],
+        "python.linting.pylintEnabled": true,
+        "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint",
+        "python.pythonPath": "/usr/local/python/bin/python",
+        "python.testing.pytestEnabled": true,
+        "python.testing.unittestEnabled": false,
+        "terminal.integrated.defaultProfile.linux": "zsh",
+        "terminal.integrated.profiles.linux": {
+          "zsh": {
+            "path": "/usr/bin/zsh"
+          }
+        }
+      }
+    }
+  },
+  // Add the IDs of extensions you want installed when the container is created.
+  "features": {
+    "ghcr.io/devcontainers/features/docker-in-docker:2": {}
+  },
+  "image": "mcr.microsoft.com/devcontainers/python:3",
+  "name": "Deebot client",
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  // "forwardPorts": [],
+  // Use 'postCreateCommand' to run commands after the container is created.
+  "postStartCommand": "pip install -r requirements-dev.txt && pre-commit install && pip install -e .",
+  // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+  "remoteUser": "vscode",
+  "runArgs": ["-e", "GIT_EDITOR=code --wait"]
+}

deebot-client-4.0.0/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

deebot-client-4.0.0/.github/FUNDING.yml

@@ -0,0 +1 @@
+custom: ["https://www.buymeacoffee.com/edenhaus"]

deebot-client-4.0.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,94 @@
+name: Report an issue
+description: Report an issue
+labels: [bug]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        This issue form is for reporting bugs only!
+
+        If you have a feature request or a question, please use discussions.
+  - type: checkboxes
+    attributes:
+      label: Checks
+      options:
+        - label: I have searched the existing issues and no issue is describing my issue
+          required: true
+        - label: I have checked the [FAQ](https://deebot.readthedocs.io/home/faq/)
+          required: true
+        - label: I have checked the [documentation](https://deebot.readthedocs.io/integrations/home-assistant)
+          required: true
+        - label: I have installed the latest version
+          required: true
+
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: The problem
+      description: >-
+        Describe the issue you are experiencing here to communicate to the
+        maintainers. Tell us what you were trying to do and what happened.
+
+        Provide a clear and concise description of what the problem is.
+
+  - type: markdown
+    attributes:
+      value: |
+        ## Environment
+  - type: input
+    id: device
+    validations:
+      required: true
+    attributes:
+      label: On which deebot device (vacuum) you have the issue?
+      placeholder: Deebot Ozmo 950
+  - type: input
+    id: version
+    validations:
+      required: true
+    attributes:
+      label: Which version of the deebot-client are you using?
+      placeholder: X.X.X
+  - type: markdown
+    attributes:
+      value: |
+        # Configuration
+  - type: input
+    id: country
+    validations:
+      required: true
+    attributes:
+      label: Country
+      placeholder: it
+      description: >
+        Which country did you input during the setup of the integration?
+  - type: input
+    id: continent
+    validations:
+      required: true
+    attributes:
+      label: Continent
+      placeholder: eu
+      description: >
+        Which continent did you input during the setup of the integration?
+
+  - type: markdown
+    attributes:
+      value: |
+        # Details
+  - type: textarea
+    attributes:
+      label: Anything in the logs that might be useful for us?
+      description: >
+        For example, error message, or stack traces.
+
+        Please refer to the [documentation](https://deebot.readthedocs.io/integrations/home-assistant/issues/).
+      render: txt
+  - type: textarea
+    attributes:
+      label: Additional information
+      description: >
+        If you have any additional information for us, use the field below.
+        Please note, you can attach screenshots or screen recordings here, by
+        dragging and dropping files in the field below.

deebot-client-4.0.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: "❓ Ask a Question"
+    url: https://github.com/DeebotUniverse/client.py/discussions/new
+    about: For asking a question please select the category "Q&A"
+  - name: "💡 Suggest an feature/idea"
+    url: https://github.com/DeebotUniverse/client.py/discussions/new
+    about: For feature request please select the category "Ideas"

deebot-client-4.0.0/.github/dependabot.yml

@@ -0,0 +1,17 @@
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    labels:
+      - "pr: dependency-update"
+    schedule:
+      interval: "daily"
+
+  # Maintain dependencies for pip
+  - package-ecosystem: "pip"
+    directory: "/"
+    labels:
+      - "pr: dependency-update"
+    schedule:
+      interval: "daily"

deebot-client-4.0.0/.github/release-drafter.yml

@@ -0,0 +1,53 @@
+name-template: "$RESOLVED_VERSION"
+tag-template: "$RESOLVED_VERSION"
+change-template: "- #$NUMBER $TITLE @$AUTHOR"
+sort-direction: ascending
+filter-by-commitish: true
+categories:
+  - title: ":boom: Breaking changes"
+    label: "pr: Breaking Change"
+
+  - title: ":sparkles: New features"
+    label: "pr: new-feature"
+
+  - title: ":zap: Enhancements"
+    label: "pr: enhancement"
+
+  - title: ":recycle: Refactor"
+    label: "pr: refactor"
+
+  - title: ":bug: Bug Fixes"
+    label: "pr: bugfix"
+
+  - title: ":arrow_up: Dependency Updates"
+    labels:
+      - "pr: dependency-update"
+      - "dependencies"
+
+include-labels:
+  - "pr: Breaking Change"
+  - "pr: enhancement"
+  - "pr: dependency-update"
+  - "pr: new-feature"
+  - "pr: bugfix"
+  - "pr: refactor"
+
+version-resolver:
+  major:
+    labels:
+      - "pr: Breaking Change"
+  minor:
+    labels:
+      - "pr: enhancement"
+      - "pr: dependency-update"
+      - "pr: new-feature"
+  patch:
+    labels:
+      - "pr: bugfix"
+  default: patch
+
+template: |
+  $CHANGES
+
+  **Like my work and want to support me?**
+  <a href="https://www.buymeacoffee.com/edenhaus" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-black.png" width="150px" height="35px" alt="Buy Me A Coffee" style="height: 35px !important;width: 150px !important;" ></a>

deebot-client-4.0.0/.github/workflows/ci.yml

@@ -0,0 +1,60 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+  pull_request:
+
+env:
+  DEFAULT_PYTHON: "3.11"
+
+jobs:
+  code-quality:
+    runs-on: "ubuntu-latest"
+    name: Check code quality
+    steps:
+      - uses: "actions/checkout@v4"
+      - name: Set up Python ${{ env.DEFAULT_PYTHON }}
+        id: python
+        uses: actions/setup-python@v5.0.0
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON }}
+          cache: "pip"
+          cache-dependency-path: "requirements*"
+      - name: Install dependencies
+        run: |
+          pip install -r requirements.txt
+          pip install -r requirements-test.txt
+      # Following steps cannot run by pre-commit.ci as repo = local
+      - name: Run mypy
+        run: mypy deebot_client/
+      - name: Pylint review
+        run: pylint deebot_client/
+      - name: Verify no getLogger usages
+        run: scripts/check_getLogger.sh
+
+  tests:
+    runs-on: "ubuntu-latest"
+    name: Run tests
+    steps:
+      - uses: "actions/checkout@v4"
+      - name: Set up Python ${{ env.DEFAULT_PYTHON }}
+        id: python
+        uses: actions/setup-python@v5.0.0
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON }}
+          cache: "pip"
+          cache-dependency-path: "requirements*"
+      - name: Install dependencies
+        run: |
+          pip install -r requirements.txt
+          pip install -r requirements-test.txt
+      - name: Run pytest
+        run: pytest --cov=./ --cov-report=xml
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: true

deebot-client-4.0.0/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,71 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+  pull_request:
+  schedule:
+    - cron: "20 10 * * 0"
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ["python"]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
+
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
+
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
+
+      # - run: |
+      #   make bootstrap
+      #   make release
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2

deebot-client-4.0.0/.github/workflows/python-publish.yml

@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+# 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: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write
+    steps:
+      - name: 📥 Checkout the repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5.0.0
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -q build
+
+      - name: 📦 Build package
+        run: python -m build
+
+      - name: 📤 Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1

deebot-client-4.0.0/.github/workflows/release-drafter.yml

@@ -0,0 +1,16 @@
+name: Release Drafter
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: release-drafter/release-drafter@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

deebot-client-4.0.0/.gitignore

@@ -0,0 +1,23 @@
+__pycache__
+Pipfile
+Pipfile.lock
+scratch*
+.idea
+build
+dist
+venv
+
+# Nosetests files
+cover/
+.coverage
+
+# Ignore Vscode files
+.vscode
+
+*.egg-info/
+.noseids
+nosetests.xml
+
+.*_cache
+
+test.py

deebot-client-4.0.0/.pre-commit-config.yaml

@@ -0,0 +1,85 @@
+ci:
+  autofix_prs: false
+  skip:
+    # This steps run in the ci workflow. Keep in sync
+    - mypy
+    - pylint
+    - verifyNoGetLogger
+
+default_language_version:
+  python: python3.11
+
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.6
+    hooks:
+      - id: ruff
+        args:
+          - --fix
+          # - --unsafe-fixes
+      - id: ruff-format
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.15.0
+    hooks:
+      - id: pyupgrade
+        args:
+          - --py311-plus
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.6
+    hooks:
+      - id: codespell
+        args:
+          - --ignore-words-list=hass,deebot
+          - --skip="./.*,*.csv,*.json"
+          - --quiet-level=2
+        exclude_types:
+          - csv
+          - json
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-executables-have-shebangs
+      - id: check-merge-conflict
+      - id: detect-private-key
+      - id: no-commit-to-branch
+        args: [--branch, main, --branch, dev]
+      - id: requirements-txt-fixer
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.1.0
+    hooks:
+      - id: prettier
+        additional_dependencies:
+          - prettier@3.1.0
+          - prettier-plugin-sort-json@3.1.0
+        exclude_types:
+          - python
+  - repo: https://github.com/adrienverge/yamllint.git
+    rev: v1.33.0
+    hooks:
+      - id: yamllint
+  - repo: local
+    hooks:
+      # Run mypy through our wrapper script in order to get the possible
+      # pyenv and/or virtualenv activated; it may not have been e.g. if
+      # committing from a GUI tool that was not launched from an activated
+      # shell.
+      - id: mypy
+        name: Check with mypy
+        entry: scripts/run-in-env.sh mypy
+        language: script
+        types:
+          - python
+        require_serial: true
+      - id: pylint
+        name: Check with pylint
+        entry: scripts/run-in-env.sh pylint
+        language: script
+        types:
+          - python
+        require_serial: true
+        exclude: ^tests/.+
+      - id: verifyNoGetLogger
+        name: Verify no getLogger usages
+        entry: scripts/check_getLogger.sh
+        language: script
+        require_serial: true

deebot-client-4.0.0/.prettierrc.js

@@ -0,0 +1,5 @@
+/** @type {import("prettier").Config} */
+module.exports = {
+  plugins: [require.resolve("prettier-plugin-sort-json")],
+  jsonRecursiveSort: true,
+};

deebot-client-4.0.0/.yamllint

@@ -0,0 +1,59 @@
+rules:
+  braces:
+    level: error
+    min-spaces-inside: 0
+    max-spaces-inside: 1
+    min-spaces-inside-empty: -1
+    max-spaces-inside-empty: -1
+  brackets:
+    level: error
+    min-spaces-inside: 0
+    max-spaces-inside: 0
+    min-spaces-inside-empty: -1
+    max-spaces-inside-empty: -1
+  colons:
+    level: error
+    max-spaces-before: 0
+    max-spaces-after: 1
+  commas:
+    level: error
+    max-spaces-before: 0
+    min-spaces-after: 1
+    max-spaces-after: 1
+  comments:
+    level: error
+    require-starting-space: true
+    min-spaces-from-content: 2
+  comments-indentation:
+    level: error
+  document-end:
+    level: error
+    present: false
+  document-start:
+    level: error
+    present: false
+  empty-lines:
+    level: error
+    max: 1
+    max-start: 0
+    max-end: 1
+  hyphens:
+    level: error
+    max-spaces-after: 1
+  indentation:
+    level: error
+    spaces: 2
+    indent-sequences: true
+    check-multi-line-strings: false
+  key-duplicates:
+    level: error
+  line-length: disable
+  new-line-at-end-of-file:
+    level: error
+  new-lines:
+    level: error
+    type: unix
+  trailing-spaces:
+    level: error
+  truthy:
+    disable