arkindex-client 1.0.16__py3-none-any.whl → 1.1.0__py3-none-any.whl

arkindex_client-1.1.0.dist-info/METADATA

@@ -0,0 +1,27 @@
+Metadata-Version: 2.1
+Name: arkindex-client
+Version: 1.1.0
+Summary: API client for the Arkindex project
+Home-page: https://gitlab.teklia.com/arkindex/api-client
+Author: Teklia <contact@teklia.com>
+License: AGPL-v3
+Keywords: api client arkindex
+Classifier: License :: OSI Approved :: MIT License
+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.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering :: Image Recognition
+Classifier: Topic :: Text Processing :: Indexing
+Classifier: Topic :: Text Processing :: Linguistic
+Requires-Python: >=3.8
+License-File: LICENSE
+Requires-Dist: requests~=2.28
+Requires-Dist: tenacity==8.2.3
+Requires-Dist: typesystem==0.2.5
+
+Documentation is available at https://api.arkindex.org

arkindex_client-1.1.0.dist-info/RECORD

@@ -0,0 +1,23 @@
+apistar/__init__.py,sha256=mX65SD-MGA1ZynGKkqh7zEONxAIMsPktTaAXeh69Kwc,231
+apistar/exceptions.py,sha256=yzjDlUB5o0xaORBabqTXmf4ckYjNHz1ceV8ECg3jDek,328
+arkindex/__init__.py,sha256=OBw25Nwe6r1AN3a36-8lnUcDy3nkDIiebBgYNK2Zo9o,99
+arkindex/auth.py,sha256=OeuzFeCQ8FAt0kqPECjsEz-Ki9__-y69z5sAuyTZ28c,1550
+arkindex/compat.py,sha256=Kjxu--QoF8sBxKOvXMtNcDQ0XK7MLc_2C8Q2knll4Lk,805
+arkindex/document.py,sha256=SUmzvuJpeHlRC4ozqnqsPFpzZ9_Yb9p6vxIZpMjMCSA,6783
+arkindex/exceptions.py,sha256=hDxbgC7uAD8wbTQS1DaEJZ25Nun41Io8Y0BiwrZ1ZSM,2016
+arkindex/mock.py,sha256=olYBFCkLQuuf9gGu7wlmZiLFMQknGGi8evS531RjjUE,2755
+arkindex/pagination.py,sha256=c6dG_OkQDG00ZfGUbHuZxu-UvOpmYf7dJP1ZaUaha1Y,9008
+arkindex/client/__init__.py,sha256=g_G_bSfMbduYzpi9iURTn0cYLV4nMulDR8rD7x-DLyc,142
+arkindex/client/base.py,sha256=vlR5HjaNQ_LzIP_FAzaZbhJSh7VzD9mXc0T8C5FB8EU,3400
+arkindex/client/client.py,sha256=lfHyicizHDxdymPA1hl0kJj7vdrudVvbE2Ei3qtZqQM,12019
+arkindex/client/decoders.py,sha256=F_uBGOrh1BFnZzuW0MTjwm8wAArbybPsrIVol_2vYN0,7886
+arkindex/client/transports.py,sha256=482CHa-8S5p190Z4cX6TiCWgz99enfloT7FCNuS02yY,4055
+arkindex/schema/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+arkindex/schema/jsonschema.py,sha256=sJ0OlkowXoE4FnA3r9_QdOmLlDP46K7YPPQm58NkfMo,2572
+arkindex/schema/openapi.py,sha256=bwVAEjdHNUf9iRPVdbQwruivs4GAwbe0db1KkLNKa80,17603
+arkindex/schema/validator.py,sha256=N2sda7vxfivw68VuyX-MfmUlrXjf_LEHNg6OCKc1mjQ,1926
+arkindex_client-1.1.0.dist-info/LICENSE,sha256=s7yDHdG8liSj2PiaVwRi9G5wR1qDXSPmhPJPgWbrkWU,34504
+arkindex_client-1.1.0.dist-info/METADATA,sha256=fBQLOlFiDD82lQgDdFhyPHeiHmnrAhPWQA2MwrnP8A0,1051
+arkindex_client-1.1.0.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
+arkindex_client-1.1.0.dist-info/top_level.txt,sha256=ALyF0lTPpxOheUGmSVwEhgI6eMYwm_9Eu37G-RwGBRM,17
+arkindex_client-1.1.0.dist-info/RECORD,,

{arkindex_client-1.0.16.dist-info → arkindex_client-1.1.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.41.2)
+Generator: bdist_wheel (0.44.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{arkindex_client-1.0.16.dist-info → arkindex_client-1.1.0.dist-info}/top_level.txt

@@ -1 +1,2 @@
+apistar
 arkindex

arkindex/transports.py

@@ -1,14 +0,0 @@
-# -*- coding: utf-8 -*-
-from apistar.client.transports import HTTPTransport
-
-
-class ArkindexHTTPTransport(HTTPTransport):
-    def __init__(self, verify=True, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.verify = verify
-
-    def get_request_options(self, *args, **kwargs):
-        options = super().get_request_options(*args, **kwargs)
-        options["timeout"] = (30, 60)
-        options["verify"] = self.verify
-        return options

arkindex_client-1.0.16.dist-info/METADATA

@@ -1,225 +0,0 @@
-Metadata-Version: 2.1
-Name: arkindex-client
-Version: 1.0.16
-Summary: API client for the Arkindex project
-Home-page: https://gitlab.teklia.com/arkindex/api-client
-Author: Teklia <contact@teklia.com>
-License: MIT
-Keywords: api client arkindex
-Platform: UNKNOWN
-Classifier: License :: OSI Approved :: MIT License
-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.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.7
-Description-Content-Type: text/x-rst
-Requires-Dist: apistar ==0.7.2
-Requires-Dist: requests ~=2.28
-Requires-Dist: tenacity ==8.2.3
-Requires-Dist: typesystem ==0.2.5
-
-Arkindex API Client
-===================
-
-``arkindex-client`` provides an API client to interact with Arkindex servers.
-
-.. contents::
-   :depth: 2
-   :local:
-   :backlinks: none
-
-Setup
------
-
-Install the client using ``pip``::
-
-   pip install arkindex-client
-
-Usage
------
-
-To create a client and login using an email/password combo,
-use the ``ArkindexClient.login`` helper method:
-
-.. code:: python
-
-   from arkindex import ArkindexClient
-   cli = ArkindexClient()
-   cli.login('EMAIL', 'PASSWORD')
-
-This helper method will save the authentication token in your API client, so
-that it is reused in later API requests.
-
-If you already have an API token, you can create your client like so:
-
-.. code:: python
-
-   from arkindex import ArkindexClient
-   cli = ArkindexClient('YOUR_TOKEN')
-
-Making requests
-^^^^^^^^^^^^^^^
-
-To perform a simple API request, you can use the ``request()`` method. The method
-takes an operation ID as a name and the operation's parameters as keyword arguments.
-
-You can open ``https://your.arkindex/api-docs/`` to access the API documentation,
-which will describe the available API endpoints, including their operation ID and
-parameters.
-
-.. code:: python
-
-   corpus = cli.request('RetrieveCorpus', id='...')
-
-The result will be a Python ``dict`` containing the result of the API request.
-If the request returns an error, an ``apistar.exceptions.ErrorResponse`` will
-be raised.
-
-Dealing with pagination
-^^^^^^^^^^^^^^^^^^^^^^^
-
-The Arkindex client adds another helper method for paginated endpoints that
-deals with pagination for you: ``ArkindexClient.paginate``. This method
-returns a ``ResponsePaginator`` instance, which is a classic Python
-iterator that does not perform any actual requests until absolutely needed:
-that is, until the next page must be loaded.
-
-.. code:: python
-
-   for element in cli.paginate('ListElements', corpus=corpus['id']):
-       print(element['name'])
-
-**Warning:** Using ``list`` on a ``ResponsePaginator`` may load dozens
-of pages at once and cause a big load on the server. You can use ``len`` to
-get the total item count before spamming a server.
-
-A call to ``paginate`` may produce hundreds of sub-requests depending on the size
-of the dataset you're requesting. To accommodate with large datasets, and support
-network or performance issues, ``paginate`` supports a ``retries`` parameter to
-specify the number of sub-request it's able to run for each page in the dataset.
-By default, the method will retry 5 times per page.
-
-You may want to allow ``paginate`` to fail on some pages, for really big datasets
-(errors happen). In this case, you should use the optional boolean parameter
-``allow_missing_data`` (set to ``False`` by default).
-
-Here is an example of pagination on a large dataset, allowing data loss, lowering
- retries and listing the missed pages:
-
-.. code:: python
-
-   elements = cli.paginate(
-       'ListProcessElements',
-       id='XXX',
-       retries=3,
-       allow_missing_data=True,
-   )
-   for element in elements:
-       print(element['id'])
-
-   print("Missing pages: {elements.missing}")
-
-
-
-Using another server
-^^^^^^^^^^^^^^^^^^^^
-
-By default, the API client is set to point to the main Arkindex server at
-https://arkindex.teklia.com. If you need or want to use this API client on
-another server, you can use the ``base_url`` keyword argument when setting up
-your API client:
-
-.. code:: python
-
-   cli = ArkindexClient(base_url='https://somewhere')
-
-Handling errors
-^^^^^^^^^^^^^^^
-
-APIStar_, the underlying API client we use, does most of the error handling.
-It will raise two types of exceptions:
-
-``apistar.exceptions.ErrorResponse``
-  The request resulted in a HTTP 4xx or 5xx response from the server.
-``apistar.exceptions.ClientError``
-  Any error that prevents the client from making the request or fetching
-  the response: invalid endpoint names or URLs, unsupported content types,
-  or unknown request parameters. See the exception messages for more info.
-
-Since this API client retrieves the endpoints description from the server
-using the base URL, errors can occur during the retrieval and parsing of the
-API schema. If this happens, an ``arkindex.exceptions.SchemaError`` exception
-will be raised.
-
-You can handle HTTP errors and fetch more information about them using the
-exception's attributes:
-
-.. code:: python
-
-   from apistar.exceptions import ErrorResponse
-   try:
-       # cli.request ...
-   except ErrorResponse as e:
-       print(e.title)   # "400 Bad Request"
-       print(e.status_code)  # 400
-       print(e.content)  # Any kind of response body the server might give
-
-Note that by default, using ``repr()`` or ``str()`` on APIStar exceptions will
-not give any useful messages; a fix in APIStar is waiting to be merged. In
-the meantime, you can use Teklia's `APIStar fork`_::
-
-   pip install git+https://gitlab.teklia.com/arkindex/apistar.git
-
-This will provide support for ``repr()`` and ``str()``, which will also
-enhance error messages on unhandled exceptions.
-
-Examples
---------
-
-Print all folders
-^^^^^^^^^^^^^^^^^
-
-.. code:: python
-
-   for folder in cli.paginate('ListElements', folder=True):
-       print(folder['name'])
-
-Download full logs for each Ponos task in a workflow
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. code:: python
-
-   workflow = cli.request('RetrieveWorkflow', id='...')
-   for task in workflow['tasks']:
-       with open(task['id'] + '.txt', 'w') as f:
-           f.write(cli.request('RetrieveTaskLog', id=task['id']))
-
-.. _APIStar: http://docs.apistar.com/
-.. _APIStar fork: https://gitlab.teklia.com/arkindex/apistar
-
-Linting
--------
-
-We use `pre-commit <https://pre-commit.com/>`_ with `black <https://github.com/psf/black>`_ to automatically format the Python source code of this project.
-
-To be efficient, you should run pre-commit before committing (hence the name...).
-
-To do that, run once :
-
-.. code:: shell
-
-   pip install pre-commit
-   pre-commit install
-
-The linting workflow will now run on modified files before committing, and will fix issues for you.
-
-If you want to run the full workflow on all the files: `pre-commit run -a`.
-
-
-

arkindex_client-1.0.16.dist-info/RECORD

@@ -1,11 +0,0 @@
-arkindex/__init__.py,sha256=OBw25Nwe6r1AN3a36-8lnUcDy3nkDIiebBgYNK2Zo9o,99
-arkindex/auth.py,sha256=O45HgpsblBqNJr9nRALU14wZgCGcmCgcGjAoD0zAyrg,1073
-arkindex/client.py,sha256=SLFJzZI31y3UAufyUBdDiUgh7_IwRK0ItRwOSgCZflU,11984
-arkindex/exceptions.py,sha256=3jzuuXgsPA28qH7GMwPVQisWCvitAQtYiQ5uKxzFQ_M,155
-arkindex/mock.py,sha256=hWU8EKfvVBAQ8VVI4Rgic809GLLDoh8Nvuvih54luKQ,2762
-arkindex/pagination.py,sha256=tIt3ecD44UcuxT3mV7gtwvqoqdeAICaq5okr1z4_xgo,8954
-arkindex/transports.py,sha256=RmQ9fXdnLd6PizifyVI5E7QTIj3MU6Xua76jp87TKpM,464
-arkindex_client-1.0.16.dist-info/METADATA,sha256=noYxsy3dMHgo0Ob_bmU3qT0c_KBAap7hW6CDz-AuEIE,7059
-arkindex_client-1.0.16.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-arkindex_client-1.0.16.dist-info/top_level.txt,sha256=iP1TxDW_jSDQA4FIcahBFXiDcZXqam2a_gFVnDbR3c4,9
-arkindex_client-1.0.16.dist-info/RECORD,,