aioautomower 1.0.0__tar.gz

aioautomower-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Thomas Peter Protzner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

aioautomower-1.0.0/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.3
+Name: aioautomower
+Version: 1.0.0
+Summary: MPython module to talk to Husqvarna Automower.
+License: MIT
+Keywords: Husqvarna,Automower,api,async,client
+Author: Thomas Peter Protzner
+Author-email: thomas.protzner@gmail.com
+Requires-Python: >=3.11,<4.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: PyJWT (>=2.8.0,<3.0.0)
+Requires-Dist: aiohttp (>=3.9.3,<4.0.0)
+Requires-Dist: ical (>=8.0.1)
+Requires-Dist: mashumaro (>=3.12,<4.0)
+Requires-Dist: python-dateutil (>=2.9.0-post.0,<3.0.0)
+Requires-Dist: tzlocal (>=5.2,<6.0)
+Project-URL: Documentation, https://github.com/Thomas55555/aioautomower
+Project-URL: Homepage, https://github.com/Thomas55555/aioautomower
+Project-URL: Issues, https://github.com/Thomas55555/aioautomower/issues
+Project-URL: Repository, https://github.com/Thomas55555/aioautomower
+Description-Content-Type: text/markdown
+
+# Aioautomower
+
+[![codecov](https://codecov.io/gh/Thomas55555/aioautomower/graph/badge.svg?token=2BG3S61T6K)](https://codecov.io/gh/Thomas55555/aioautomower)
+[![Python Versions](https://img.shields.io/pypi/pyversions/aioautomower)](https://pypi.org/project/aioautomower/)
+[![License](https://img.shields.io/github/license/Thomas55555/aioautomower.svg)](LICENSE.md)
+
+Asynchronous library to communicate with the Automower Connect API
+To use this library, you need to register on the [Husqvarna Developers Portal](https://developer.husqvarnagroup.cloud/).
+And connect your account to the `Authentication API` and the `Automower Connect API`.
+
+## Quickstart
+
+In order to use the library, you'll need to do some work yourself to get authentication
+credentials. This depends a lot on the context (e.g. redirecting to use OAuth via web)
+but should be easy to incorporate using Husqvarna's authentication examples. See
+Husqvarna's [Authentication API](https://developer.husqvarnagroup.cloud/apis/authentication-api) for details.
+
+You will implement `AbstractAuth` to provide an access token. Your implementation
+will handle any necessary refreshes. You can invoke the service with your auth implementation
+to access the API.
+
+You need at least:
+
+- Python 3.11+
+- [Poetry][poetry-install]
+
+For a first start you can run the `example.py`, by doing the following steps
+
+- `git clone https://github.com/Thomas55555/aioautomower.git`
+- `cd aioautomower`
+- `poetry install`
+- Enter your personal `client_id` and `client_secret` in the `_secrets.yaml` and rename it to `secrets.yaml`
+- Run with `poetry run ./example.py`
+
+## Contributing
+
+This is an active open-source project. We are always open to people who want to use the code or contribute to it.
+This Python project is fully managed using the [Poetry][poetry] dependency manager.
+
+As this repository uses the [pre-commit][pre-commit] framework, all changes
+are linted and tested with each commit. You can run all checks and tests
+manually, using the following command:
+
+```bash
+poetry run pre-commit run --all-files
+```
+
+To run just the Python tests:
+
+```bash
+poetry run pytest
+```
+
+To update snapshots:
+
+```bash
+poetry run pytest --snapshot-update
+```
+
+[poetry-install]: https://python-poetry.org/docs/#installation
+[poetry]: https://python-poetry.org
+[pre-commit]: https://pre-commit.com/
+
+
+# Buying Equipment
+
+Many mowers are available from your local garden dealer or major online retailers. Another like, the compact ideal for small and flat lawns, is available on Amazon.
+The links provided below are affiliate links, so if you prefer shopping on Amazon and decide to purchase something there, you’ll also be supporting me at no additional cost to you.
+Alternatively, if you'd like to support the project directly, consider contributing through [GitHub sponsors](https://github.com/sponsors/Thomas55555).
+Here are some affiliate links to support my work:
+- [Automower R4 Aspire](https://amzn.to/3Z987Oc)
+- [Endurence blades](https://amzn.to/3OyK1YD)
+- [Regular blades](https://amzn.to/3ZCn8Zt)
+- [Cabel connector](https://amzn.to/4f3OtJn)
+

aioautomower-1.0.0/README.md

@@ -0,0 +1,74 @@
+# Aioautomower
+
+[![codecov](https://codecov.io/gh/Thomas55555/aioautomower/graph/badge.svg?token=2BG3S61T6K)](https://codecov.io/gh/Thomas55555/aioautomower)
+[![Python Versions](https://img.shields.io/pypi/pyversions/aioautomower)](https://pypi.org/project/aioautomower/)
+[![License](https://img.shields.io/github/license/Thomas55555/aioautomower.svg)](LICENSE.md)
+
+Asynchronous library to communicate with the Automower Connect API
+To use this library, you need to register on the [Husqvarna Developers Portal](https://developer.husqvarnagroup.cloud/).
+And connect your account to the `Authentication API` and the `Automower Connect API`.
+
+## Quickstart
+
+In order to use the library, you'll need to do some work yourself to get authentication
+credentials. This depends a lot on the context (e.g. redirecting to use OAuth via web)
+but should be easy to incorporate using Husqvarna's authentication examples. See
+Husqvarna's [Authentication API](https://developer.husqvarnagroup.cloud/apis/authentication-api) for details.
+
+You will implement `AbstractAuth` to provide an access token. Your implementation
+will handle any necessary refreshes. You can invoke the service with your auth implementation
+to access the API.
+
+You need at least:
+
+- Python 3.11+
+- [Poetry][poetry-install]
+
+For a first start you can run the `example.py`, by doing the following steps
+
+- `git clone https://github.com/Thomas55555/aioautomower.git`
+- `cd aioautomower`
+- `poetry install`
+- Enter your personal `client_id` and `client_secret` in the `_secrets.yaml` and rename it to `secrets.yaml`
+- Run with `poetry run ./example.py`
+
+## Contributing
+
+This is an active open-source project. We are always open to people who want to use the code or contribute to it.
+This Python project is fully managed using the [Poetry][poetry] dependency manager.
+
+As this repository uses the [pre-commit][pre-commit] framework, all changes
+are linted and tested with each commit. You can run all checks and tests
+manually, using the following command:
+
+```bash
+poetry run pre-commit run --all-files
+```
+
+To run just the Python tests:
+
+```bash
+poetry run pytest
+```
+
+To update snapshots:
+
+```bash
+poetry run pytest --snapshot-update
+```
+
+[poetry-install]: https://python-poetry.org/docs/#installation
+[poetry]: https://python-poetry.org
+[pre-commit]: https://pre-commit.com/
+
+
+# Buying Equipment
+
+Many mowers are available from your local garden dealer or major online retailers. Another like, the compact ideal for small and flat lawns, is available on Amazon.
+The links provided below are affiliate links, so if you prefer shopping on Amazon and decide to purchase something there, you’ll also be supporting me at no additional cost to you.
+Alternatively, if you'd like to support the project directly, consider contributing through [GitHub sponsors](https://github.com/sponsors/Thomas55555).
+Here are some affiliate links to support my work:
+- [Automower R4 Aspire](https://amzn.to/3Z987Oc)
+- [Endurence blades](https://amzn.to/3OyK1YD)
+- [Regular blades](https://amzn.to/3ZCn8Zt)
+- [Cabel connector](https://amzn.to/4f3OtJn)

aioautomower-1.0.0/pyproject.toml

@@ -0,0 +1,426 @@
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+name = "aioautomower"
+# The version is set by GH action on release
+version = "1.0.0"
+description = "MPython module to talk to Husqvarna Automower."
+authors = [
+    "Thomas Peter Protzner <thomas.protzner@gmail.com>",
+]
+license = "MIT"
+readme = "README.md"
+packages = [
+    { include = "aioautomower", from = "src" },
+]
+homepage = "https://github.com/Thomas55555/aioautomower"
+repository = "https://github.com/Thomas55555/aioautomower"
+documentation = "https://github.com/Thomas55555/aioautomower"
+keywords = ["Husqvarna", "Automower", "api", "async", "client"]
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Framework :: AsyncIO",
+  "Intended Audience :: Developers",
+  "Natural Language :: English",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+[tool.poetry.urls]
+Issues = "https://github.com/Thomas55555/aioautomower/issues"
+
+[tool.poetry.dependencies]
+python = "^3.11"
+aiohttp = "^3.9.3"
+mashumaro = "^3.12"
+PyJWT = "^2.8.0"
+ical = ">=8.0.1"
+tzlocal = "^5.2"
+python-dateutil = "^2.9.0-post.0"
+
+[tool.poetry.group.dev.dependencies]
+aioresponses = "0.7.8"
+codespell = "2.4.1"
+covdefaults = "2.3.0"
+coverage = {version = "7.9.1", extras = ["toml"]}
+mypy = "1.16.1"
+pre-commit = "4.2.0"
+pre-commit-hooks = "5.0.0"
+pylint = "3.3.7"
+pytest = "8.4.1"
+pytest-asyncio = "1.0.0"
+pytest-cov = "6.2.1"
+ruff = "0.12.0"
+syrupy = "4.9.1"
+time-machine = "2.16.0"
+types-python-dateutil = "^2.9.0.20240821"
+types-pyyaml = "^6.0.12.20241230"
+yamllint = "1.37.1"
+
+[tool.poetry-dynamic-versioning]
+enable = true
+
+[tool.pytest.ini_options]
+addopts = "--cov=aioautomower --cov-report=term-missing -vv"
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "session"
+
+[tool.ruff]
+fix = true
+show-fixes = true
+src = ["./src"]
+target-version = "py311"
+line-length = 88
+include = ["src/**/*.py"]
+
+
+[tool.ruff.lint]
+ignore = [
+  "ANN401", # Opinioated warning on disallowing dynamically typed expressions
+  "D203", # Conflicts with other rules
+  "D213", # Conflicts with other rules
+  "D417", # False positives in some occasions
+  "PLR2004", # Just annoying, not really useful
+
+  # Conflicts with the Ruff formatter
+  "COM812",
+]
+select = ["ALL"]
+
+[tool.ruff.lint.per-file-ignores]
+# Allow for main entry & scripts to write to stdout
+"example.py" = ["T201", "T203"]
+
+[tool.pylint.FORMAT]
+max-line-length = 88
+
+[tool.ruff.lint.flake8-annotations]
+allow-star-arg-any = true
+suppress-dummy-args = true
+
+[tool.ruff.lint.flake8-builtins]
+builtins-ignorelist = ["id"]
+
+[tool.ruff.lint.pydocstyle]
+# Use Google-style docstrings.
+convention = "pep257"
+
+[tool.ruff.lint.pylint]
+max-branches=25
+max-returns=15
+max-args=10
+max-statements=50
+
+[tool.pylint]
+ignore = ["R0902"]
+
+[tool.pylint.MASTER]
+ignore = [
+  "tests",
+]
+
+[tool.pylint."MESSAGES CONTROL"]
+# Reasons disabled:
+# format - handled by ruff
+# locally-disabled - it spams too much
+# duplicate-code - unavoidable
+# cyclic-import - doesn't test if both import on load
+# abstract-class-little-used - prevents from setting right foundation
+# unused-argument - generic callbacks and setup methods create a lot of warnings
+# too-many-* - are not enforced for the sake of readability
+# too-few-* - same as too-many-*
+# abstract-method - with intro of async there are always methods missing
+# inconsistent-return-statements - doesn't handle raise
+# too-many-ancestors - it's too strict.
+# wrong-import-order - isort guards this
+# possibly-used-before-assignment - too many errors / not necessarily issues
+# ---
+# Pylint CodeStyle plugin
+disable = [
+    "format",
+    "abstract-method",
+    "cyclic-import",
+    "duplicate-code",
+    "inconsistent-return-statements",
+    "locally-disabled",
+    "not-context-manager",
+    "too-few-public-methods",
+    "too-many-ancestors",
+    "too-many-arguments",
+    "too-many-instance-attributes",
+    "too-many-lines",
+    "too-many-locals",
+    "too-many-public-methods",
+    "too-many-boolean-expressions",
+    "too-many-positional-arguments",
+    "wrong-import-order",
+    "possibly-used-before-assignment",
+
+    # Handled by ruff
+    # Ref: <https://github.com/astral-sh/ruff/issues/970>
+    "await-outside-async", # PLE1142
+    "bad-str-strip-call", # PLE1310
+    "bad-string-format-type", # PLE1307
+    "bidirectional-unicode", # PLE2502
+    "continue-in-finally", # PLE0116
+    "duplicate-bases", # PLE0241
+    "misplaced-bare-raise", # PLE0704
+    "format-needs-mapping", # F502
+    "function-redefined", # F811
+    # Needed because ruff does not understand type of __all__ generated by a function
+    # "invalid-all-format", # PLE0605
+    "invalid-all-object", # PLE0604
+    "invalid-character-backspace", # PLE2510
+    "invalid-character-esc", # PLE2513
+    "invalid-character-nul", # PLE2514
+    "invalid-character-sub", # PLE2512
+    "invalid-character-zero-width-space", # PLE2515
+    "logging-too-few-args", # PLE1206
+    "logging-too-many-args", # PLE1205
+    "missing-format-string-key", # F524
+    "mixed-format-string", # F506
+    "no-method-argument", # N805
+    "no-self-argument", # N805
+    "nonexistent-operator", # B002
+    "nonlocal-without-binding", # PLE0117
+    "not-in-loop", # F701, F702
+    "notimplemented-raised", # F901
+    "return-in-init", # PLE0101
+    "return-outside-function", # F706
+    "syntax-error", # E999
+    "too-few-format-args", # F524
+    "too-many-format-args", # F522
+    "too-many-star-expressions", # F622
+    "truncated-format-string", # F501
+    "undefined-all-variable", # F822
+    "undefined-variable", # F821
+    "used-prior-global-declaration", # PLE0118
+    "yield-inside-async-function", # PLE1700
+    "yield-outside-function", # F704
+    "anomalous-backslash-in-string", # W605
+    "assert-on-string-literal", # PLW0129
+    "assert-on-tuple", # F631
+    "bad-format-string", # W1302, F
+    "bad-format-string-key", # W1300, F
+    "bare-except", # E722
+    "binary-op-exception", # PLW0711
+    "cell-var-from-loop", # B023
+    # "dangerous-default-value", # B006, ruff catches new occurrences, needs more work
+    "duplicate-except", # B014
+    "duplicate-key", # F601
+    "duplicate-string-formatting-argument", # F
+    "duplicate-value", # F
+    "eval-used", # S307
+    "exec-used", # S102
+    "expression-not-assigned", # B018
+    "f-string-without-interpolation", # F541
+    "forgotten-debug-statement", # T100
+    "format-string-without-interpolation", # F
+    # "global-statement", # PLW0603, ruff catches new occurrences, needs more work
+    "global-variable-not-assigned", # PLW0602
+    "implicit-str-concat", # ISC001
+    "import-self", # PLW0406
+    "inconsistent-quotes", # Q000
+    "invalid-envvar-default", # PLW1508
+    "keyword-arg-before-vararg", # B026
+    "logging-format-interpolation", # G
+    "logging-fstring-interpolation", # G
+    "logging-not-lazy", # G
+    "misplaced-future", # F404
+    "named-expr-without-context", # PLW0131
+    "nested-min-max", # PLW3301
+    "pointless-statement", # B018
+    "raise-missing-from", # B904
+    "redefined-builtin", # A001
+    "try-except-raise", # TRY302
+    "unused-argument", # ARG001, we don't use it
+    "unused-format-string-argument", #F507
+    "unused-format-string-key", # F504
+    "unused-import", # F401
+    "unused-variable", # F841
+    "useless-else-on-loop", # PLW0120
+    "wildcard-import", # F403
+    "bad-classmethod-argument", # N804
+    "consider-iterating-dictionary", # SIM118
+    "empty-docstring", # D419
+    "invalid-name", # N815
+    "line-too-long", # E501, disabled globally
+    "missing-class-docstring", # D101
+    "missing-final-newline", # W292
+    "missing-function-docstring", # D103
+    "missing-module-docstring", # D100
+    "multiple-imports", #E401
+    "singleton-comparison", # E711, E712
+    "subprocess-run-check", # PLW1510
+    "superfluous-parens", # UP034
+    "ungrouped-imports", # I001
+    "unidiomatic-typecheck", # E721
+    "unnecessary-direct-lambda-call", # PLC3002
+    "unnecessary-lambda-assignment", # PLC3001
+    "unnecessary-pass", # PIE790
+    "unneeded-not", # SIM208
+    "useless-import-alias", # PLC0414
+    "wrong-import-order", # I001
+    "wrong-import-position", # E402
+    "comparison-of-constants", # PLR0133
+    "comparison-with-itself", # PLR0124
+    "consider-merging-isinstance", # PLR1701
+    "consider-using-dict-comprehension", # C402
+    "consider-using-generator", # C417
+    "consider-using-get", # SIM401
+    "consider-using-set-comprehension", # C401
+    "consider-using-sys-exit", # PLR1722
+    "consider-using-ternary", # SIM108
+    "literal-comparison", # F632
+    "property-with-parameters", # PLR0206
+    "super-with-arguments", # UP008
+    "too-many-branches", # PLR0912
+    "too-many-return-statements", # PLR0911
+    "too-many-statements", # PLR0915
+    "trailing-comma-tuple", # COM818
+    "unnecessary-comprehension", # C416
+    "use-a-generator", # C417
+    "use-dict-literal", # C406
+    "use-list-literal", # C405
+    "useless-object-inheritance", # UP004
+    "useless-return", # PLR1711
+    "no-else-break", # RET508
+    "no-else-continue", # RET507
+    "no-else-raise", # RET506
+    "no-else-return", # RET505
+    "broad-except", # BLE001
+    "protected-access", # SLF001
+    "broad-exception-raised", # TRY002
+    "consider-using-f-string", # PLC0209
+    # "no-self-use", # PLR6301  # Optional plugin, not enabled
+
+    # Handled by mypy
+    # Ref: <https://github.com/antonagestam/pylint-mypy-overlap>
+    "abstract-class-instantiated",
+    "arguments-differ",
+    "assigning-non-slot",
+    "assignment-from-no-return",
+    "assignment-from-none",
+    "bad-exception-cause",
+    "bad-format-character",
+    "bad-reversed-sequence",
+    "bad-super-call",
+    "bad-thread-instantiation",
+    "catching-non-exception",
+    "comparison-with-callable",
+    "deprecated-class",
+    "dict-iter-missing-items",
+    "format-combined-specification",
+    "global-variable-undefined",
+    "import-error",
+    "inconsistent-mro",
+    "inherit-non-class",
+    "init-is-generator",
+    "invalid-class-object",
+    "invalid-enum-extension",
+    "invalid-envvar-value",
+    "invalid-format-returned",
+    "invalid-hash-returned",
+    "invalid-metaclass",
+    "invalid-overridden-method",
+    "invalid-repr-returned",
+    "invalid-sequence-index",
+    "invalid-slice-index",
+    "invalid-slots-object",
+    "invalid-slots",
+    "invalid-star-assignment-target",
+    "invalid-str-returned",
+    "invalid-unary-operand-type",
+    "invalid-unicode-codec",
+    "isinstance-second-argument-not-valid-type",
+    "method-hidden",
+    "misplaced-format-function",
+    "missing-format-argument-key",
+    "missing-format-attribute",
+    "missing-kwoa",
+    "no-member",
+    "no-value-for-parameter",
+    "non-iterator-returned",
+    "non-str-assignment-to-dunder-name",
+    "nonlocal-and-global",
+    "not-a-mapping",
+    "not-an-iterable",
+    "not-async-context-manager",
+    "not-callable",
+    "not-context-manager",
+    "overridden-final-method",
+    "raising-bad-type",
+    "raising-non-exception",
+    "redundant-keyword-arg",
+    "relative-beyond-top-level",
+    "self-cls-assignment",
+    "signature-differs",
+    "star-needs-assignment-target",
+    "subclassed-final-class",
+    "super-without-brackets",
+    "too-many-function-args",
+    "typevar-double-variance",
+    "typevar-name-mismatch",
+    "unbalanced-dict-unpacking",
+    "unbalanced-tuple-unpacking",
+    "unexpected-keyword-arg",
+    "unhashable-member",
+    "unpacking-non-sequence",
+    "unsubscriptable-object",
+    "unsupported-assignment-operation",
+    "unsupported-binary-operation",
+    "unsupported-delete-operation",
+    "unsupported-membership-test",
+    "used-before-assignment",
+    "using-final-decorator-in-unsupported-version",
+    "wrong-exception-operation",
+]
+enable = [
+    #"useless-suppression",  # temporarily every now and then to clean them up
+    "use-symbolic-message-instead",
+]
+
+[tool.mypy]
+platform = "linux"
+python_version = "3.11"
+strict = true
+namespace_packages = true
+mypy_path = "src"
+
+# show error messages from unrelated files
+follow_imports = "normal"
+
+# suppress errors about unsatisfied imports
+ignore_missing_imports = true
+
+# strict rules
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_subclassing_any = true
+disallow_untyped_calls = true
+disallow_untyped_decorators = true
+disallow_untyped_defs = true
+no_implicit_optional = true
+no_implicit_reexport = true
+strict_optional = true
+warn_incomplete_stub = true
+warn_no_return = true
+warn_redundant_casts = true
+warn_return_any = true
+warn_unused_configs = true
+warn_unused_ignores = true
+
+
+[tool.coverage.report]
+show_missing = true
+fail_under = 50
+
+[tool.coverage.run]
+plugins = ["covdefaults"]
+source = ["aioautomower"]

aioautomower-1.0.0/src/aioautomower/__init__.py

@@ -0,0 +1,11 @@
+"""Automower library using aiohttp."""
+
+__all__ = [
+    "auth",
+    "commands",
+    "const",
+    "exceptions",
+    "model",
+    "session",
+    "utils",
+]