mg-saic-client 0.9.4__tar.gz

mg_saic_client-0.9.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 The SAIC-iSmart-API project
+
+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.

mg_saic_client-0.9.4/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.4
+Name: mg-saic-client
+Version: 0.9.4
+Summary: SAIC next gen client library (MG iSMART)
+License-File: LICENSE
+Author: Giovanni Condello
+Author-email: saic-python-client@nanomad.net
+Requires-Python: >=3.11
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Dist: dacite (>=1.8.1,<2.0.0)
+Requires-Dist: httpx (>=0.27.0,<0.29.0)
+Requires-Dist: pycryptodome (>=3.20.0,<4.0.0)
+Requires-Dist: tenacity (>=9.0.0,<10.0.0)
+Project-URL: Homepage, https://github.com/SAIC-iSmart-API/saic-python-client-ng
+Project-URL: Issues, https://github.com/SAIC-iSmart-API/saic-python-client-ng/issues
+Description-Content-Type: text/markdown
+
+# SAIC Python client library
+
+## About
+
+A Python package for interacting with the MG iSmart API.
+
+MG iSmart is the connectivity system in your MG car (MG5 MG4, ZS, MGS5, MGS6 ...).
+
+Supported functionality (partial list, check the code for more)
+
+* login
+* set alarm switches
+* get message list
+* get vehicle status
+* get charging status
+* lock vehicle
+* unlock vehicle
+* start rear window heating
+* stop rear window heating
+* remote climate
+* heated seats
+
+
+## Prerequisites
+
+You have an iSmart account (can be created in the iSmart app)
+
+## Credit
+
+This is a maintained fork of [SAIC-iSmart-API/saic-python-client-ng](https://github.com/SAIC-iSmart-API/saic-python-client-ng) by Giovanni Condello, used by the [mg-saic-ha](https://github.com/townsmcp/mg-saic-ha) Home Assistant integration. Licensed under MIT; see [LICENSE](LICENSE).
+

mg_saic_client-0.9.4/README.md

@@ -0,0 +1,30 @@
+# SAIC Python client library
+
+## About
+
+A Python package for interacting with the MG iSmart API.
+
+MG iSmart is the connectivity system in your MG car (MG5 MG4, ZS, MGS5, MGS6 ...).
+
+Supported functionality (partial list, check the code for more)
+
+* login
+* set alarm switches
+* get message list
+* get vehicle status
+* get charging status
+* lock vehicle
+* unlock vehicle
+* start rear window heating
+* stop rear window heating
+* remote climate
+* heated seats
+
+
+## Prerequisites
+
+You have an iSmart account (can be created in the iSmart app)
+
+## Credit
+
+This is a maintained fork of [SAIC-iSmart-API/saic-python-client-ng](https://github.com/SAIC-iSmart-API/saic-python-client-ng) by Giovanni Condello, used by the [mg-saic-ha](https://github.com/townsmcp/mg-saic-ha) Home Assistant integration. Licensed under MIT; see [LICENSE](LICENSE).

mg_saic_client-0.9.4/pyproject.toml

@@ -0,0 +1,231 @@
+[project]
+name = "mg-saic-client"
+version = "0.9.4"
+description = "SAIC next gen client library (MG iSMART)"
+authors = [
+    { name = "Giovanni Condello", email = "saic-python-client@nanomad.net" },
+]
+readme = "README.md"
+
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+requires-python = ">=3.11"
+
+dependencies = [
+    "pycryptodome (>=3.20.0,<4.0.0)",
+    "httpx (>=0.27.0,<0.29.0)",
+    "tenacity (>=9.0.0,<10.0.0)",
+    "dacite (>=1.8.1,<2.0.0)"
+]
+
+[project.urls]
+Homepage = "https://github.com/SAIC-iSmart-API/saic-python-client-ng"
+Issues = "https://github.com/SAIC-iSmart-API/saic-python-client-ng/issues"
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+packages = [{ include = "saic_ismart_client_ng", from = "src" }]
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.2.2"
+mock = "^5.1.0"
+coverage = "^7.5.4"
+ruff = "^0.12.0"
+pytest-cov = "^5.0.0"
+pytest-asyncio = "^0.24.0"
+pytest-mock = "^3.14.0"
+mypy = "^1.15.0"
+pylint = "^3.3.6"
+pre-commit = "^4.2.0"
+
+[tool.pytest.ini_options]
+norecursedirs = ".git build dist"
+testpaths = "tests"
+pythonpath = [
+    "src"
+]
+mock_use_standalone_module = true
+addopts = [
+    "--import-mode=importlib",
+]
+asyncio_default_fixture_loop_scope = "function"
+
+[tool.coverage.run]
+omit = [
+    "tests/*",
+]
+branch = true
+command_line = "-m pytest"
+
+[tool.coverage.report]
+# Regexes for lines to exclude from consideration
+exclude_lines = [
+    # Have to re-enable the standard pragma
+    'pragma: no cover',
+    # Don't complain about missing debug-only code:
+    'def __repr__',
+    'if self\.debug',
+    # Don't complain if tests don't hit defensive assertion code:
+    'raise AssertionError',
+    'raise NotImplementedError',
+    # Don't complain if non-runnable code isn't run:
+    'if 0:',
+    'if __name__ == .__main__.:',
+]
+ignore_errors = true
+
+[tool.ruff]
+include = [
+    "src/**/*.py",
+    "tests/**/*.py",
+    "**/pyproject.toml"
+]
+
+[tool.ruff.lint]
+select = ["ALL"]
+
+ignore = [
+    "ANN401", # Opinioated warning on disallowing dynamically typed expressions
+    "D203", # Conflicts with other rules
+    "D213", # Conflicts with other rules
+    "EM101", # raw-string-in-exception
+
+    "D105", # Missing docstring in magic method
+    "D107", # Missing docstring in `__init__`
+    "E501", # line too long
+
+    "FBT", # flake8-boolean-trap
+
+    "PLR2004", # Magic value used in comparison, consider replacing {value} with a constant variable
+
+    # Used to map JSON responses
+    "N815",
+    # Conflicts with the Ruff formatter
+    "COM812",
+    # We use Exception istead of Error
+    "N818",
+    # Remove later
+    "D100", # Missing docstring in public module
+    "D101", # Missing docstring in public class
+    "D102", # Missing docstring in public method
+    "D103", # Missing docstring in public function
+    "D104", # Missing docstring in public package
+    "D106", # Missing docstring in public nested class
+    "TD", # Todos
+    "A", # bultins
+    "DTZ", # use tz need to test it first
+    "TRY", # tryceratops
+    "FIX002", # Line contains TODO, consider resolving the issue
+    "BLE001", # Do not catch blind exception: `Exception`,
+    "PLR0913", # Too many arguments in function definition
+    "ERA001"   # Commented-out code
+
+]
+
+[tool.ruff.lint.flake8-pytest-style]
+fixture-parentheses = false
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
+force-sort-within-sections = true
+known-first-party = ["saic_ismart_client_ng"]
+required-imports = ["from __future__ import annotations"]
+
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = [
+    "D100", # Missing docstring in public module
+    "D103", # Missing docstring in public function
+    "D104", # Missing docstring in public package
+    "N802", # Function name {name} should be lowercase
+    "N816", # Variable {name} in global scope should not be mixedCase
+    "S101", # Use of assert detected
+    "SLF001", # Private member accessed: {access}
+    "T201", # print found
+]
+
+[tool.ruff.lint.mccabe]
+max-complexity = 13
+
+[tool.ruff.lint.pylint]
+max-args = 10
+
+[tool.mypy]
+files = ["./src", "./tests"]
+python_version = 3.11
+show_error_codes = true
+strict_equality = true
+warn_incomplete_stub = true
+warn_redundant_casts = true
+warn_unused_configs = true
+warn_unused_ignores = true
+check_untyped_defs = 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
+warn_return_any = true
+warn_unreachable = true
+strict = true
+
+[tool.pylint.MAIN]
+py-version = "3.11"
+ignore = ["tests"]
+fail-on = ["I"]
+
+[tool.pylint.BASIC]
+good-names = ["i", "j", "k", "ex", "_", "T", "x", "y", "id", "tg"]
+
+[tool.pylint."MESSAGES CONTROL"]
+# Reasons disabled:
+# format - handled by black
+# duplicate-code - unavoidable
+# cyclic-import - doesn't test if both import on load
+# abstract-class-little-used - prevents from setting right foundation
+# 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
+# ---
+# Pylint CodeStyle plugin
+# consider-using-namedtuple-or-dataclass - too opinionated
+# consider-using-assignment-expr - decision to use := better left to devs
+disable = [
+    "format",
+    "cyclic-import",
+    "duplicate-code",
+    "too-many-arguments",
+    "too-many-instance-attributes",
+    "too-many-locals",
+    "too-many-ancestors",
+    "too-few-public-methods",
+    "invalid-name",
+    # Remove later
+    "missing-function-docstring",
+    "missing-module-docstring",
+    "missing-class-docstring",
+    "broad-exception-caught",
+    "logging-fstring-interpolation",
+    "fixme"
+]
+enable = ["useless-suppression", "use-symbolic-message-instead"]
+
+[tool.pylint.REPORTS]
+score = false
+
+[tool.pylint.FORMAT]
+expected-line-ending-format = "LF"
+
+[tool.pylint.EXCEPTIONS]
+overgeneral-exceptions = ["builtins.BaseException", "builtins.Exception"]

mg_saic_client-0.9.4/src/saic_ismart_client_ng/__init__.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+from saic_ismart_client_ng.api.message import SaicMessageApi
+from saic_ismart_client_ng.api.user import SaicUserApi
+from saic_ismart_client_ng.api.vehicle.alarm import SaicVehicleAlarmApi
+from saic_ismart_client_ng.api.vehicle.climate import SaicVehicleClimateApi
+from saic_ismart_client_ng.api.vehicle.locks import SaicVehicleLocksApi
+from saic_ismart_client_ng.api.vehicle.windows import SaicVehicleWindowsApi
+from saic_ismart_client_ng.api.vehicle_charging import SaicVehicleChargingApi
+
+
+class SaicApi(
+    SaicUserApi,
+    SaicMessageApi,
+    SaicVehicleAlarmApi,
+    SaicVehicleLocksApi,
+    SaicVehicleWindowsApi,
+    SaicVehicleClimateApi,
+    SaicVehicleChargingApi,
+):
+    """The SAIC Api client."""