viqi-api 0.0__py3-none-any.whl

viqi_api-0.0.dist-info/METADATA

@@ -0,0 +1,166 @@
+Metadata-Version: 2.4
+Name: viqi_api
+Version: 0.0
+Summary: ViQi Python API
+Author-email: ViQi Inc <info@viqi.org>
+Project-URL: homepage, https://www.viqi.org
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: configparser
+Requires-Dist: bisque-metadoc>=0.6.4.16
+Requires-Dist: tifffile
+Requires-Dist: furl
+Requires-Dist: simplejson
+Requires-Dist: shortuuid>=1.0.8
+Requires-Dist: tenacity
+Requires-Dist: importlib-metadata; python_version < "3.10"
+Requires-Dist: boto3>=1.28.52
+Requires-Dist: urllib3>=2.0.0
+Requires-Dist: requests>=2.32.0
+Requires-Dist: requests-cache>=1.1.0
+Requires-Dist: requests-toolbelt>=1.0.0
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: webtest; extra == "test"
+Requires-Dist: pandas; extra == "test"
+Requires-Dist: numpy; extra == "test"
+Requires-Dist: tables; extra == "test"
+Requires-Dist: responses; extra == "test"
+Requires-Dist: imagecodecs; extra == "test"
+Provides-Extra: image-service
+Requires-Dist: tifffile; extra == "image-service"
+Requires-Dist: tables; extra == "image-service"
+Provides-Extra: table-service
+Requires-Dist: numpy; extra == "table-service"
+Requires-Dist: pandas; extra == "table-service"
+Requires-Dist: tables; extra == "table-service"
+
+# ViQi API
+
+Low level interface to ViQi services
+
+
+## Install
+
+
+`pip install viqi-api `
+
+## Configuration
+
+For command line tools create `~/.config/viqi/profiles`  or `~/config/viqi/profiles`` (windows) with the following
+
+```
+[default]
+host=https://science.viqiai.cloud
+user=myuser
+password=mysecret
+
+[science-user2]
+host=https://science.viqiai.cloud
+user=myuser2
+password=mysecret2
+
+# Admin can switch to another user
+[science-secret-user]
+host=https://science.viqiai.cloud
+user=admin@viqi.org
+password=admin_secret
+alias=secret-user@viqi.org
+```
+
+## Documentation
+* [viqi-api](https://viqi.gitlab.io/viqi-common/bisque-api/)
+  1. [Service-oriented API](https://viqi.gitlab.io/viqi-common/bisque-api/soapi.html)
+  1. [Object-oriented API](https://viqi.gitlab.io/viqi-common/bisque-api/ooapi.html)
+
+
+## Usage & Initialization
+
+The `viqi_session` helper provides a flexible way to initialize a session, whether from command line arguments, configuration files, or direct parameters in Python.
+
+### 1. From Command Line Arguments (Scripts)
+
+When used in a script without arguments, `viqi_session()` automatically parses `sys.argv`. This is the standard way to write scripts that can be configured via flags or config files.
+
+**myscript.py**:
+```python
+from vqapi import viqi_session
+session = viqi_session()
+
+if session:
+    # Session is ready and connected
+    print(f"Connected to {session.bqServer} as {session.user}")
+
+    # Access services
+    meta = session.service("meta")
+    # ...
+```
+
+**Run it:**
+```bash
+# Using explicit credentials
+python myscript.py --host https://science.viqiai.cloud --user myuser --password mysecret
+
+# Using a profile defined in ~/.config/viqi/profiles
+python myscript.py --profile default
+```
+
+### 2. From Python Parameters (Interactive/Library)
+
+You can pass arguments directly as keyword arguments. This is useful for interactive sessions (like IPython/Jupyter) or when embedding the library.
+
+```python
+from vqapi import viqi_session
+
+# Using a profile defined in ~/.config/viqi/profiles
+session = viqi_session(profile="science-user2")
+
+# Using explicit credentials
+session = viqi_session(
+    host="https://science.viqiai.cloud",
+    user="myuser",
+    password="mysecret"
+)
+
+# Using an auth token
+session = viqi_session(
+    host="https://science.viqiai.cloud",
+    authtoken="YOUR_AUTH_TOKEN"
+)
+```
+
+### 3. Simulating Command Line Arguments
+
+You can pass a list of strings to `args` to simulate command line input.
+
+```python
+session = viqi_session(args=["--host", "https://science.viqiai.cloud", "--user", "admin", "--password", "secret"])
+```
+
+### 4. Custom Argument Parser
+
+If your script requires its own custom arguments, you can extend the standard ViQi parser.
+
+```python
+import argparse
+from vqapi import viqi_session, viqi_argument_parser
+
+# 1. Start with the standard ViQi parser
+parser = viqi_argument_parser()
+
+# 2. Add your custom arguments
+parser.add_argument("--dataset-id", required=True, help="ID of dataset to process")
+
+# 3. Parse args (handles both ViQi args and custom args)
+args = parser.parse_args()
+
+# 4. Initialize session using the parsed arguments
+session = viqi_session(args=args)
+
+# 5. Use your custom argument
+print(f"Processing dataset: {args.dataset_id}")
+```

viqi_api-0.0.dist-info/RECORD

@@ -0,0 +1,28 @@
+vqapi/__init__.py,sha256=QZ7xXIfkeGzi21EMSpyAKFdlYebTJJTecXOpL3cGDaI,411
+vqapi/blockable_module.py,sha256=zMeKq_h2TZLGAvnvuJbf9K0LdzWHNjs_iRdRaB81f8M,1746
+vqapi/bqclass.py,sha256=QOUA_nAMdDuyOQ9Kv-Jdu7B003_3IJxsH7OeGUZLqQ8,28753
+vqapi/casauth.py,sha256=Q6oSLC0reYxMTJ_I-h76hoyT6BP2LM1kTltC9RAX5nU,1594
+vqapi/cmd.py,sha256=Pz0lh0971jxds1pJVBDLAkwBPAge6slVR9hiPAxZO18,12519
+vqapi/comm.py,sha256=110YQ6siXCw0kCf9JuzzcgsJt5UtATUhiThIdfpI4fI,52083
+vqapi/exception.py,sha256=JYoJrReRe-QMFzkOYXPq9TMQ7Va4Gz21VBsEWDUbb4Y,17395
+vqapi/loggingpool.py,sha256=YH6VvN5PtVo-dWuxPPQ35wYgu9PzR_4hGUfQcwwFCZ0,4740
+vqapi/plugins.py,sha256=E8oIcaBetoo80TkjWZqks1N2Mz3QW3H5x7eRRXMj0Fs,4824
+vqapi/util.py,sha256=-P8t1TVEqUWCuKuzDbDcTSQ9EoAtzEpyxdNKln7eCqc,16380
+vqapi/version.py,sha256=UC5T8KT6NqfFyLIGvmK4WnGPXZQFrOLavnm8I-_0Bg8,515
+vqapi/vqclass.py,sha256=aJnWauXIpZqcc6BaaaFqYVWvd9blAkv9wvDcLZRfs5I,78987
+vqapi/vqquery.py,sha256=RTqo2c_ornG2Lmi3QoH4S5pxVBY7TPF3fuaTQGbcGIk,11547
+vqapi/RequestsMonkeyPatch/__init__.py,sha256=9_8wL9Scv8_Cs8HJyJHGvx1vwXErsuvlsAqNZLcJQR0,8
+vqapi/RequestsMonkeyPatch/monkeypatch.py,sha256=Dl9WR-wicHkgxKRWZ4yXvs4RMuu9v3CSY3fBMlH3Fl0,138
+vqapi/RequestsMonkeyPatch/requests_patch.py,sha256=1sIq472wvuAY5F96E_Q8jHsxiDlq0iBT3Ycm5eQUNZ0,1993
+vqapi/services/__init__.py,sha256=fndmO-p3S3jd5c0cP7dlDj-emxPHjm7X4L_f8PP_YA8,120
+vqapi/services/base_proxy.py,sha256=9jwdP51Pc6IwLBz43m3SmhBVAlN_Y47EW4O3HwyZlck,24658
+vqapi/services/core_services.py,sha256=BjWkmSBBFbN5j_Pw0f7DRURczJt5v3yO4MB1LN6rHDs,56635
+vqapi/services/factory.py,sha256=HSUE-lEo086FKbJcESjotL5Yrlk7sRfX02co6ehPgW0,1877
+vqapi/services/image_proxy.py,sha256=QGmCAGk5qI8qVOx50ioeu8ZrHBYSLrgAUm9XtUKinAI,3253
+vqapi/services/import_proxy.py,sha256=cZx8HZI5mAXSfO-O9N_xyBxBhKGlPvN4shnxw1R9PlI,50223
+vqapi/services/table_proxy.py,sha256=Yn6svLCtElnfbEUtaJw-c050ntF_jSCjMOmjjr1V0uM,11664
+vqapi/services/threadpool.py,sha256=PcWx52hVYwteol_wvHiwwTe-RMqZoL2gMDRN6afjDLA,5733
+viqi_api-0.0.dist-info/METADATA,sha256=AjJdCZL9-7SyXNVJiSu3ZpTTAi7uYnMg8KrJt6Rg8Qw,4671
+viqi_api-0.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+viqi_api-0.0.dist-info/top_level.txt,sha256=3tj8lcUB1FkjX_EiiFuj3I18i3_LJydRRS0stEFKdJU,6
+viqi_api-0.0.dist-info/RECORD,,

viqi_api-0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (83.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

viqi_api-0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+vqapi

vqapi/RequestsMonkeyPatch/__init__.py

@@ -0,0 +1 @@
+# empty

vqapi/RequestsMonkeyPatch/monkeypatch.py

@@ -0,0 +1,6 @@
+def monkeypatch_method(cls):
+    def decorator(func):
+        setattr(cls, func.__name__, func)
+        return func
+
+    return decorator

vqapi/RequestsMonkeyPatch/requests_patch.py

@@ -0,0 +1,66 @@
+"""
+A patch to format_header_param in urllib3
+
+If a value has unicode the header will be returned
+as 'name="value"; name*=utf-8''value' else
+'name="value"'
+"""
+
+import email.utils
+
+# import mimetypes
+import warnings
+
+import requests
+
+try:
+    import requests.packages.urllib3 as urllib3  # pylint: disable=import-error
+except ImportError:
+    import urllib3
+
+# from requests.packages.urllib3.packages import six #pylint: disable=import-error
+from .monkeypatch import monkeypatch_method
+
+REQUESTS_V = [int(s) for s in requests.__version__.split(".")]
+
+if REQUESTS_V < [2, 4, 0]:  # or  REQUESTS_V > [2, 19, 0]:
+    warnings.warn(
+        """\
+We need to patch requests 2.4.0  make sure your version of requests \
+needs this patch, greater than 2.X we do not know if this patch applys."""
+    )
+    raise ImportError("Requests > 2.4.0 is required!")
+# elif requests_v > [3, 0, 0]:
+#    #does not require this patch
+#    pass
+else:
+
+    @monkeypatch_method(urllib3.fields)
+    def format_header_param(name, value):
+        """
+        Helper function to format and quote a single header parameter.
+
+        Particularly useful for header parameters which might contain
+        non-ASCII values, like file names. This follows RFC 2231, as
+        suggested by RFC 2388 Section 4.4.
+
+        :param name:
+            The name of the parameter, a string expected to be ASCII only.
+        :param value:
+            The value of the parameter, provided as a unicode string.
+        """
+        if not any(ch in value for ch in '"\\\r\n'):
+            result = f'{name}="{value}"'
+            try:
+                result.encode("ascii")
+            except UnicodeEncodeError:
+                pass
+            else:
+                return result
+
+        value_encode = str(value)
+        # if not six.PY3: # Python 2:
+        #    value_encode = value.encode('utf-8')
+
+        value = '{}="{}"; {}*={}'.format(name, value, name, email.utils.encode_rfc2231(value_encode, "utf-8"))
+        return value

vqapi/__init__.py

@@ -0,0 +1,17 @@
+#
+from .cmd import (
+    bisque_argument_parser,
+    bisque_config,
+    bisque_session,
+    viqi_argument_parser,
+    viqi_config,
+    viqi_session,
+)
+from .comm import BQServer, BQSession
+from .exception import *
+from .services import ResponseFile, ResponseFolder, StorageLevel, SearchScope, FilterType
+from .vqclass import *
+
+__author__ = "ViQi Inc"
+__copyright__ = "2018-2025 ViQi Inc"
+__project__ = "vqapi"

vqapi/blockable_module.py

@@ -0,0 +1,59 @@
+import collections
+import logging
+
+from vqapi import BQSession
+
+# import sys
+
+
+# logging.basicConfig(filename='BlockableModule.log',level=logging.DEBUG)   #!!!
+log = logging.getLogger("vqapi.blockable_module")
+
+
+class BlockableModule:
+    """Base class for module that can run over blocks of parameters"""
+
+    def main(self, mex_url=None, auth_token=None, bq=None, **kw):
+        #  Allow for testing by passing an alreay initialized session
+        if bq is None:
+            bq = BQSession().init_mex(mex_url, auth_token)
+
+        # check for list parameters
+        params = bq.get_mex_inputs()
+        if isinstance(params, dict) or not isinstance(params, collections.abc.Iterable):
+            params = [params]
+        # pass values directly as args
+        for single_params in params:
+            for param_name in single_params:
+                if "value" in single_params[param_name]:
+                    single_params[param_name] = single_params[param_name].get("value")
+
+        # TODO: measure block startup time
+        self.start_block(bq, params)
+
+        for kw in params:
+            # TODO: measure single item time
+            # TODO: run in parallel
+            if "mex_url" in kw:
+                # set (innermost) single item mex
+                sub_bq = BQSession().init_mex(kw["mex_url"], auth_token)
+            else:
+                sub_bq = bq
+            self.process_single(sub_bq, **kw)
+            if "mex_url" in kw:
+                sub_bq.close()
+
+        # TODO: measure block teardown time
+        self.end_block(bq)
+
+        # sys.exit(0)
+        bq.close()
+
+    def start_block(self, bq, all_kw):
+        pass
+
+    def end_block(self, bq):
+        pass
+
+    def process_single(self, bq, **kw):
+        pass