qmenta-client 2.2.0.dev1522__tar.gz → 3.0.0.dev1524__tar.gz

{qmenta_client-2.2.0.dev1522 → qmenta_client-3.0.0.dev1524}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: qmenta-client
-Version: 2.2.0.dev1522
+Version: 3.0.0.dev1524
 Summary: Python client lib to interact with the QMENTA platform.
 Author: QMENTA
 Author-email: dev@qmenta.com
@@ -14,5 +14,5 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: future (>=0.18.2,<0.19.0)
 Requires-Dist: pytest-cov (>=6.1.1,<7.0.0)
-Requires-Dist: qmenta-core (==4.1.1)
+Requires-Dist: qmenta-core (==5.0.0.dev723)
 Project-URL: Homepage, https://www.qmenta.com/

{qmenta_client-2.2.0.dev1522 → qmenta_client-3.0.0.dev1524}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "qmenta-client"
-version = "2.2.0.dev1522"
+version = "3.0.0.dev1524"
 description = "Python client lib to interact with the QMENTA platform."
 authors = ["QMENTA <dev@qmenta.com>"]
 homepage = "https://www.qmenta.com/"
@@ -15,7 +15,7 @@ packages = [
 [tool.poetry.dependencies]
 python = "^3.10"
 future = "^0.18.2"
-qmenta-core = "4.1.1"
+qmenta-core = "5.0.0.dev723"
 pytest-cov = "^6.1.1"
 
 [tool.poetry.group.dev.dependencies]
@@ -27,8 +27,6 @@ scriv = {version = "^0.15.2", extras = ["toml"]}
 coverage = "^7.2.5"
 flake8 = "^7.1.2"
 responses = "^0.25.7"
-cyclonedx-bom = "^7.0.0"
-
 
 [build-system]
 requires = ["poetry-core>=2.0.0,<3.0.0"]

{qmenta_client-2.2.0.dev1522 → qmenta_client-3.0.0.dev1524}/src/qmenta/client/Account.py

@@ -3,6 +3,7 @@ from __future__ import print_function
 import logging
 from qmenta.core import errors
 from qmenta.core import platform
+from qmenta.core.auth import InvalidLoginError
 from urllib3.exceptions import HTTPError
 
 from .Project import Project
@@ -19,14 +20,27 @@ class Account:
 
     Parameters
     ----------
-    username : str
+    username : str, optional
         Username on the platform. To get one go to https://platform.qmenta.com
-    password : str
+    password : str, optional
         The password assigned to the username.
     base_url : str
         The base url of the platform.
     verify_certificates : bool
         verify SSL certificates?
+    api_key : str, optional
+        The API-KEY associated to the user.
+
+    Valid credential combinations
+    -----------------------------
+    username + password
+        Classic login. If two-factor authentication (2FA) is enabled on the
+        account, the user is prompted for the code interactively.
+    api_key
+        API-key login. 2FA is not required.
+    username + password + api_key
+        All three values are forwarded to the authentication layer, which
+        decides which credential to use.
 
     Attributes
     ----------
@@ -36,15 +50,17 @@ class Account:
 
     def __init__(
         self,
-        username,
-        password,
+        username=None,
+        password=None,
         base_url="https://platform.qmenta.com",
         verify_certificates=True,
+        api_key=None,
     ):
 
         self._cookie = None
         self.username = username
         self.password = password
+        self.api_key = api_key
         self.baseurl = base_url
         self.verify_certificates = verify_certificates
         self.auth = None
@@ -58,21 +74,37 @@ class Account:
         """
         Login to the platform.
 
+        Uses the credentials set on the instance (``username``/``password``
+        and/or ``api_key``). Valid combinations:
+
+        - ``username`` + ``password``: classic login. If 2FA is enabled on
+          the account, the user is prompted for the code interactively.
+        - ``api_key``: API-key login. 2FA is not required.
+        - ``username`` + ``password`` + ``api_key``: all values are forwarded
+          to the authentication layer, which decides which credential to use.
+
         Raises
         ------
+        qmenta.core.auth.InvalidLoginError
+            When the provided credentials are invalid.
         qmenta.core.platform.ConnectionError
             When the connection to the platform fails.
-        qmenta.core.platform.InvalidLoginError
-            When invalid credentials are provided.
+        qmenta.core.errors.PlatformError
+            When the platform returns an unexpected error.
         """
         logger = logging.getLogger(logger_name)
         try:
             auth = platform.Auth.login(
-                self.username,
-                self.password,
+                username=self.username,
+                password=self.password,
+                api_key=self.api_key,
                 base_url=self.baseurl,
                 ask_for_2fa_input=True,
             )
+        except InvalidLoginError as e:
+            logger.error("Failed to log in: {}".format(e))
+            self.auth = None
+            raise
         except errors.PlatformError as e:
             logger.error("Failed to log in: {}".format(e))
             self.auth = None