arkindex-client 1.0.9__tar.gz → 1.0.12__tar.gz

{arkindex-client-1.0.9 → arkindex-client-1.0.12}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.1
 Name: arkindex-client
-Version: 1.0.9
+Version: 1.0.12
 Summary: API client for the Arkindex project
-Home-page: https://gitlab.com/arkindex/api-client
+Home-page: https://gitlab.com/teklia/arkindex/api-client
 Author: Teklia <contact@teklia.com>
 License: MIT
 Keywords: api client arkindex
@@ -12,12 +12,12 @@ Classifier: Natural Language :: English
 Classifier: Intended Audience :: Science/Research
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
 Classifier: Topic :: Scientific/Engineering :: Image Recognition
 Classifier: Topic :: Text Processing :: Indexing
 Classifier: Topic :: Text Processing :: Linguistic
-Requires-Python: >=3.6
+Requires-Python: >=3.7
 Description-Content-Type: text/x-rst
 
 Arkindex API Client

arkindex-client-1.0.12/VERSION

@@ -0,0 +1 @@
+1.0.12

{arkindex-client-1.0.9 → arkindex-client-1.0.12}/arkindex/client.py

@@ -32,9 +32,18 @@ def options_from_env():
     Get API client keyword arguments from environment variables.
     """
     options = {}
-    if "ARKINDEX_API_TOKEN" in os.environ:
+    # ARKINDEX_TASK_TOKEN takes priority over ARKINDEX_API_TOKEN
+    if "ARKINDEX_TASK_TOKEN" in os.environ:
+        options["auth_scheme"] = "Ponos"
+        options["token"] = os.environ.get("ARKINDEX_TASK_TOKEN")
+    elif "ARKINDEX_API_TOKEN" in os.environ:
+        options["auth_scheme"] = "Token"
         options["token"] = os.environ.get("ARKINDEX_API_TOKEN")
 
+    # Allow overriding the default auth schemes
+    if "ARKINDEX_API_AUTH_SCHEME" in os.environ:
+        options["auth_scheme"] = os.environ.get("ARKINDEX_API_AUTH_SCHEME")
+
     if "ARKINDEX_API_URL" in os.environ:
         options["base_url"] = os.environ.get("ARKINDEX_API_URL")
 
@@ -63,6 +72,7 @@ class ArkindexClient(apistar.Client):
     def __init__(
         self,
         token=None,
+        auth_scheme="Token",
         base_url=DEFAULT_BASE_URL,
         schema_url=None,
         csrf_cookie=None,
@@ -139,7 +149,11 @@ class ArkindexClient(apistar.Client):
             csrf_cookie = csrf_cookies.get(split_base_url.netloc) or "arkindex.csrf"
 
         self.configure(
-            token=token, base_url=base_url, csrf_cookie=csrf_cookie, sleep=sleep
+            token=token,
+            auth_scheme=auth_scheme,
+            base_url=base_url,
+            csrf_cookie=csrf_cookie,
+            sleep=sleep,
         )
 
     def __repr__(self):
@@ -151,12 +165,25 @@ class ArkindexClient(apistar.Client):
     def init_transport(self, *args, **kwargs):
         return ArkindexHTTPTransport(*args, **kwargs)
 
-    def configure(self, token=None, base_url=None, csrf_cookie=None, sleep=None):
+    def configure(
+        self,
+        token=None,
+        auth_scheme="Token",
+        base_url=None,
+        csrf_cookie=None,
+        sleep=None,
+    ):
         """
         Reconfigure the API client.
 
         :param token: An API token to use. If omitted, access is restricted to public endpoints.
         :type token: str or None
+        :param auth_scheme:
+           An authentication scheme to use. This is added in the HTTP header before the token:
+           ``Authorization: [scheme] [token]``.
+           This should use ``Token`` to authenticate as a regular user and ``Ponos`` to authenticate as a Ponos task.
+           If omitted, this defaults to ``Token``.
+        :type auth_scheme: str or None
         :param base_url: A custom base URL for the client. If omitted, defaults to the Arkindex main server.
         :type base_url: str or None
         :param csrf_cookie: Use a custom CSRF cookie name. Falls back to ``arkindex.csrf``.
@@ -167,7 +194,9 @@ class ArkindexClient(apistar.Client):
         if not csrf_cookie:
             csrf_cookie = "arkindex.csrf"
         self.transport.session.auth = TokenSessionAuthentication(
-            token, csrf_cookie_name=csrf_cookie
+            token,
+            csrf_cookie_name=csrf_cookie,
+            scheme=auth_scheme,
         )
 
         if not sleep or not isinstance(sleep, float) or sleep < 0:
@@ -200,6 +229,7 @@ class ArkindexClient(apistar.Client):
         """
         resp = self.request("Login", body={"email": email, "password": password})
         if "auth_token" in resp:
+            self.transport.session.auth.scheme = "Token"
             self.transport.session.auth.token = resp["auth_token"]
         return resp
 

{arkindex-client-1.0.9 → arkindex-client-1.0.12}/arkindex/pagination.py

@@ -81,6 +81,14 @@ class ResponsePaginator(Sized, Iterator):
         ), "allow_missing_data must be a boolean"
 
     def _fetch_page(self):
+        """
+        Retrieve the next page and store its results
+
+        Returns None in case of a failure
+        Returns True in case the page returned results
+        Returns False in case the page returned an empty result
+        Raises a StopIteration in case there are no pages left to iterate on
+        """
         # Filter out pages with no retries
         # Transform as a list of tuples for simpler output
         remaining = sorted([(m, v) for m, v in self.pages.items() if v > 0])
@@ -136,7 +144,7 @@ class ResponsePaginator(Sized, Iterator):
                 if self.count == 0:
                     # Pagination has retrieved 0 results
                     self.pages = {}
-                    return
+                    return False
                 self.pages_count = math.ceil(self.count / len(self.results))
                 logger.info(
                     f"Pagination will load a total of {self.pages_count} pages."
@@ -161,7 +169,7 @@ class ResponsePaginator(Sized, Iterator):
 
             # Stop happy path here, we don't need to process errors
             self.pages_loaded += 1
-            return self.data
+            return True
 
         except apistar.exceptions.ErrorResponse as e:
             logger.warning(f"API Error {e.status_code} on pagination: {e.content}")
@@ -194,6 +202,9 @@ class ResponsePaginator(Sized, Iterator):
             else:
                 raise Exception("Stopping pagination as data will be incomplete")
 
+        # No data could be fetch, return None
+        return None
+
     def __iter__(self):
         return self
 
@@ -216,7 +227,12 @@ class ResponsePaginator(Sized, Iterator):
     def __len__(self):
         # Handle calls to len when no requests have been made yet
         if not self.pages_loaded and self.count is None:
-            self._fetch_page()
+            # Continuously try to fetch a page until there are no retries left
+            while self._fetch_page() is None:
+                pass
+        # Count may be null in case of a StopIteration
+        if self.count is None:
+            raise Exception("An error occurred fetching items total count")
         return self.count
 
     def __repr__(self):

{arkindex-client-1.0.9 → arkindex-client-1.0.12}/arkindex_client.egg-info/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.1
 Name: arkindex-client
-Version: 1.0.9
+Version: 1.0.12
 Summary: API client for the Arkindex project
-Home-page: https://gitlab.com/arkindex/api-client
+Home-page: https://gitlab.com/teklia/arkindex/api-client
 Author: Teklia <contact@teklia.com>
 License: MIT
 Keywords: api client arkindex
@@ -12,12 +12,12 @@ Classifier: Natural Language :: English
 Classifier: Intended Audience :: Science/Research
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
 Classifier: Topic :: Scientific/Engineering :: Image Recognition
 Classifier: Topic :: Text Processing :: Indexing
 Classifier: Topic :: Text Processing :: Linguistic
-Requires-Python: >=3.6
+Requires-Python: >=3.7
 Description-Content-Type: text/x-rst
 
 Arkindex API Client

{arkindex-client-1.0.9 → arkindex-client-1.0.12}/arkindex_client.egg-info/requires.txt

@@ -1,3 +1,3 @@
 apistar==0.7.2
-requests==2.27.1
+requests==2.28.1
 typesystem==0.2.5

{arkindex-client-1.0.9 → arkindex-client-1.0.12}/requirements.txt

@@ -1,3 +1,3 @@
 apistar==0.7.2
-requests==2.27.1
+requests==2.28.1
 typesystem==0.2.5

{arkindex-client-1.0.9 → arkindex-client-1.0.12}/setup.py

@@ -16,21 +16,21 @@ setup(
     ),
     package_data={"": ["*.rst", "LICENSE", "README"], "arkindex": ["schema.yml"]},
     install_requires=read_requirements("requirements.txt"),
-    python_requires=">=3.6",
+    python_requires=">=3.7",
     license="MIT",
     description="API client for the Arkindex project",
     long_description=open("README.rst").read(),
     long_description_content_type="text/x-rst",
     keywords="api client arkindex",
-    url="https://gitlab.com/arkindex/api-client",
+    url="https://gitlab.com/teklia/arkindex/api-client",
     classifiers=[
         "License :: OSI Approved :: MIT License",
         "Natural Language :: English",
         "Intended Audience :: Science/Research",
         "Programming Language :: Python :: 3",
         "Programming Language :: Python :: 3 :: Only",
-        "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
         "Topic :: Scientific/Engineering :: Image Recognition",
         "Topic :: Text Processing :: Indexing",
         "Topic :: Text Processing :: Linguistic",

arkindex-client-1.0.9/VERSION

@@ -1 +0,0 @@
-1.0.9