qmenta-core 4.1.1.dev722__tar.gz → 5.0.0.dev723__tar.gz

{qmenta_core-4.1.1.dev722 → qmenta_core-5.0.0.dev723}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: qmenta-core
-Version: 4.1.1.dev722
+Version: 5.0.0.dev723
 Summary: QMENTA core library to communicate with the QMENTA platform.
 License: Proprietary
 Author: QMENTA

{qmenta_core-4.1.1.dev722 → qmenta_core-5.0.0.dev723}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "qmenta-core"
-version = "4.1.1.dev722"
+version = "5.0.0.dev723"
 description = "QMENTA core library to communicate with the QMENTA platform."
 license = "Proprietary"
 authors = ["QMENTA <dev@qmenta.com>"]

{qmenta_core-4.1.1.dev722 → qmenta_core-5.0.0.dev723}/src/qmenta/core/auth.py

@@ -111,12 +111,34 @@ class Auth:
         return cls(url, token)
 
     @classmethod
-    def login(cls, username: str, password: str,
+    def login(cls,
+              username: Optional[str] = None,
+              password: Optional[str] = None,
               code_2fa: Optional[str] = None,
+              *,
+              api_key: Optional[str] = None,
               ask_for_2fa_input: bool = False,
               base_url: str = PlatformURL.platform.value) -> 'Auth':
         """
-        Authenticate to the platform using username and password.
+        Authenticate to the platform using username and password,
+        or an API key.
+
+        ``api_key``, ``ask_for_2fa_input``, and ``base_url`` must be passed
+        as keyword arguments.
+
+        Valid parameter combinations:
+
+        - ``username``, ``password``: standard login.
+        - ``username``, ``password``, ``code_2fa``: login with a
+          pre-supplied 2FA code.
+        - ``username``, ``password``, ``ask_for_2fa_input=True``: login
+          and prompt for the 2FA code interactively when required.
+        - ``api_key``: login using an API key.
+
+        ``base_url`` can be combined with any of the above to target a
+        specific platform environment.
+        When ``username`` + ``password`` and ``api_key`` are all provided,
+        ``username`` + ``password`` takes precedence.
 
         Parameters
         ----------
@@ -128,6 +150,10 @@ class Auth:
             The QMENTA platform password of the user.
         code_2fa : str
             The 2FA code that was sent to your phone (optional).
+        api_key : str
+            A QMENTA API key. See the platform manual to learn how to
+            generate one. When provided together with ``username`` and
+            ``password``, the username/password credentials take precedence.
         ask_for_2fa_input: bool
             When set to True, the user is asked input the 2FA code
             in the command-line interface when it is needed. If the user does
@@ -154,21 +180,36 @@ class Auth:
             If the platform returned an invalid response.
         InvalidLoginError
             If the login was invalid. This can happen when the
-            username/password combination is incorrect, or when the account is
-            not active or 2FA is required to be set up.
+            username/password combination is incorrect, when the api_key is
+            invalid, when the account is not active, or when 2FA is required
+            to be set up. Also raised when neither credentials nor api_key
+            are provided.
         Needs2FAError
             When a login attempt was done without a valid 2FA code.
             The 2FA code has been sent to your phone, and must be provided
             in the next call to the login function.
         """
         url: str = urljoin(base_url, '/login')
-
-        try:
-            response: requests.Response = requests.post(
-                url, data={
+        if username and password:
+            request_data = {
                     'username': username, 'password': password,
                     'code_2fa': code_2fa
                 }
+            headers = {}
+        elif api_key:
+            headers = {
+                    'X-QMENTA-API-KEY': api_key
+                }
+            request_data = {}
+        else:
+            raise InvalidLoginError(
+                'Missing username and password, or api-key'
+            )
+        try:
+            response: requests.Response = requests.post(
+                url,
+                data=request_data,
+                headers=headers
             )
             # Raises an exception for 4xx and 5xx status codes
             response.raise_for_status()
@@ -186,7 +227,6 @@ class Auth:
             raise ConnectionError(str(e))
         except Exception as e:
             raise Exception("An error occurred:", e)
-
         try:
             if data["success"] != 1:
                 # Login was not successful