feat(python): add support for the upcoming auth update (#207)

Co-authored-by: Dominic Reber <[email protected]>
Co-authored-by: Enrico Eberhard <[email protected]>

python/CHANGELOG.md

@@ -12,6 +12,10 @@ Release Versions:
 - [1.0.1](#101)
 - [1.0.0](#100)
 
+## Upcoming changes
+
+- feat(python): add support for the upcoming auth update (#207)
+
 ## 3.0.0
 
 Version 3.0.0 of the AICA API client is compatible with the new AICA Core version 4.0. It supports additional methods to
@@ -65,4 +69,4 @@ Version 1.0.1 fixes a relative import issue.
 ## 1.0.0
 
 Version 1.0.0 marks the version for the first software release. From now on, all changes must be well documented and
-semantic versioning must be maintained to reflect patch, minor or major changes.
+semantic versioning must be maintained to reflect patch, minor or major changes.

python/examples/with_api_key.py

@@ -0,0 +1,12 @@
+import os
+
+from aica_api.client import AICA
+
+client = AICA(
+    api_key=os.getenv('AICA_API_KEY'),
+)
+
+assert client.check()
+print(f'Application state: {client.get_application_state().text}')
+print(f'Application state: {client.load_component("def").text}')
+print(client.wait_for_component('abc', 'loaded'))

python/pyproject.toml

@@ -5,25 +5,33 @@ build-backend = "hatchling.build"
 [project]
 name = "aica_api"
 version = "3.0.0"
-authors = [
-  { name="Enrico Eberhard", email="[email protected]" },
-]
+authors = [{ name = "Enrico Eberhard", email = "[email protected]" }]
 description = "A client utility for the AICA API"
 readme = "README.md"
 requires-python = ">=3.7"
 dependencies = [
-    "deprecation ~= 2.1.0",
-    "python-socketio[client] ~= 5.11.0",
-    "pyyaml ~= 6.0.1",
-    "requests ~= 2.28.1",
-    "semver ~= 3.0.2"
+  "deprecation ~= 2.1.0",
+  "python-socketio[client] ~= 5.11.0",
+  "pyyaml ~= 6.0.1",
+  "requests ~= 2.28.1",
+  "semver ~= 3.0.2",
 ]
 classifiers = [
-    "Programming Language :: Python :: 3",
-    "License :: OSI Approved :: MIT License",
-    "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
 ]
 
 [project.urls]
 "Homepage" = "https://github.com/aica-technology/api"
 "Bug Tracker" = "https://github.com/aica-technology/api/issues"
+
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+ignore = ["D212", "D400", "D415", "FA100", "G004"]
+
+[tool.ruff.format]
+quote-style = "single"