osducli 0.0.50__py3-none-any.whl → 0.0.52__py3-none-any.whl

osducli/VERSION

@@ -1 +1 @@
-0.0.50
+0.0.52

osducli/commands/search/query.py

@@ -12,12 +12,18 @@
 
 """Search service query command"""
 
+import collections
+
 import click
+from jmespath import Options
+from jmespath import compile as compile_jmespath
 from osdu_api.model.search.query_request import QueryRequest
 
 from osducli.click_cli import CustomClickCommand, State, command_with_output
 from osducli.cliclient import CliOsduClient, handle_cli_exceptions
 
+QUERY_JMESPATH_EXPRESSION = compile_jmespath("results[*].{Id:id,Kind:kind,CreateTime:createTime}")
+AGGREGATE_JMESPATH_EXPRESSION = compile_jmespath("sort_by(aggregations,&key)[*].{Key:key,Count:count}")
 
 # click entry point
 @click.command(cls=CustomClickCommand)
@@ -32,14 +38,15 @@ from osducli.cliclient import CliOsduClient, handle_cli_exceptions
     show_default=True,
     help="maximum number of records to return.",
 )
+@click.option("-a", "--aggregate", "_aggr", help="Aggregate by element", required=False)
 @handle_cli_exceptions
-@command_with_output("results[*].{Id:id,Kind:kind,CreateTime:createTime}")
-def _click_command(state: State, kind: str, _id: str, _query: str, limit: int):
+@command_with_output(None)
+def _click_command(state: State, kind: str, _id: str, _query: str, limit: int, _aggr: str):
     """Search using more advanced query terms"""
-    return query(state, kind, _id, _query, limit)
+    return query(state, kind, _id, _query, limit, _aggr)
 
 
-def query(state: State, kind: str, identifier: str, custom_query: str, limit: int):
+def query(state: State, kind: str, identifier: str, custom_query: str, limit: int, aggregate: str = None):
     """Query search service
 
     Args:
@@ -48,6 +55,7 @@ def query(state: State, kind: str, identifier: str, custom_query: str, limit: in
         identifier (str): id to search for
         custom_query (str): custom search query
         limit (int): maximum number of records to return.
+        aggregate (str): aggregate by element
     """
     client = CliOsduClient(state.config)
     search_client = client.get_search_client()
@@ -59,8 +67,13 @@ def query(state: State, kind: str, identifier: str, custom_query: str, limit: in
         kind = "*:*:*:*"
 
     query_val = f'id:("{identifier}")' if identifier is not None else custom_query
-    request_data = QueryRequest(kind=kind, query=query_val, limit=limit)
+    request_data = QueryRequest(kind=kind, query=query_val, limit=limit, aggregate_by=aggregate)
 
     response = search_client.query_records(query_request=request_data)
     client.check_status_code(response)
-    return response.json()
+    response_data = response.json()
+
+    if aggregate is not None:
+        return AGGREGATE_JMESPATH_EXPRESSION.search(response_data, Options(collections.OrderedDict))
+
+    return QUERY_JMESPATH_EXPRESSION.search(response_data, Options(collections.OrderedDict))

osducli/commands/storage/version/__init__.py

@@ -0,0 +1,13 @@
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+"""Storage service version commands"""

osducli/commands/storage/version/get.py

@@ -0,0 +1,47 @@
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+"""Storage service version get command"""
+
+import click
+
+from osducli.click_cli import CustomClickCommand, State, command_with_output
+from osducli.cliclient import CliOsduClient, handle_cli_exceptions
+
+
+# click entry point
+@click.command(cls=CustomClickCommand)
+@click.option("-id", "--id", "_id", help="Record id to search for", required=True)
+@click.option("-v", "--version", "_ver", help="Record version to search for", required=True)
+@click.option("-a", "--attributes", "_attr", help="Filter attributes to restrict the returned fields of the record.", required=False)
+@handle_cli_exceptions
+@command_with_output("results || {Id:id,Version:version,Kind:kind,CreateUser:createUser,CreateTime:createTime}")
+def _click_command(state: State, _id: str, _ver: str, _attr: list):
+    """Get specific record by id and version"""
+    return get(state, _id, _ver, _attr)
+
+
+def get(state: State, id: str, version: str, attributes: list = None): # pylint: disable=redefined-builtin
+    """Get specific record by id and version
+
+    Args:
+        state (State): Global state
+        id (str): Id of records
+        version (str): Version of records
+        attributes (list): Filter attributes
+    """
+    client = CliOsduClient(state.config)
+    record_client = client.get_storage_record_client()
+    response = record_client.get_specific_record(id, version, attributes)
+
+    client.check_status_code(response)
+    return response.json()

osducli/commands/storage/{versions.py → version/list.py}

@@ -10,33 +10,34 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-"""Storage service versions command"""
+"""Storage service version list command"""
 
 import click
 
 from osducli.click_cli import CustomClickCommand, State, command_with_output
 from osducli.cliclient import CliOsduClient, handle_cli_exceptions
-from osducli.config import CONFIG_STORAGE_URL
 
 
 # click entry point
 @click.command(cls=CustomClickCommand)
-@click.option("-id", "--id", "_id", required=True, help="id to get versions for")
+@click.option("-id", "--id", "_id", help="Record id to search for", required=True)
 @handle_cli_exceptions
 @command_with_output("versions")
 def _click_command(state: State, _id: str):
-    """List record versions"""
-    return versions(state, _id)
+    """Get record versions for given id"""
+    return get(state, _id)
 
 
-def versions(state: State, id: str):  # pylint: disable=invalid-name,redefined-builtin
-    """List record versions
+def get(state: State, id: str): # pylint: disable=redefined-builtin
+    """Get record versions for given id
 
     Args:
         state (State): Global state
-        id (str): id to get versions for
+        id (str): Id of records
     """
-    connection = CliOsduClient(state.config)
-    url = "records/versions/" + id
-    json = connection.cli_get_returning_json(CONFIG_STORAGE_URL, url)
-    return json
+    client = CliOsduClient(state.config)
+    record_client = client.get_storage_record_client()
+    response = record_client.get_record_versions(id)
+
+    client.check_status_code(response)
+    return response.json()

{osducli-0.0.50.dist-info → osducli-0.0.52.dist-info}/METADATA

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: osducli
-Version: 0.0.50
+Version: 0.0.52
 Summary: OSDU command line
-Author-email: Equinor ASA <mhew@equinor.com>
+Author: OSDU Community
 License-Expression: Apache-2.0
 Project-URL: homepage, https://community.opengroup.org/osdu/platform/data-flow/data-loading/osdu-cli
 Project-URL: issue-tracker, https://community.opengroup.org/osdu/platform/data-flow/data-loading/osdu-cli/-/issues
@@ -11,7 +11,7 @@ Classifier: Development Status :: 3 - Alpha
 Classifier: Environment :: Console
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3.13
-Requires-Python: >=3.12
+Requires-Python: >=3.13
 Description-Content-Type: text/x-rst
 License-File: LICENSE.md
 Requires-Dist: click
@@ -75,6 +75,15 @@ For more information, specify the `-h` flag:
 Change Log
 ==========
 
+0.0.52
+------
+- Fix result for aggregate in search command
+
+0.0.51
+------
+- Get record version command
+- Aggregate by in search query
+
 0.0.50
 ------
 - Maintenance release

{osducli-0.0.50.dist-info → osducli-0.0.52.dist-info}/RECORD

@@ -1,4 +1,4 @@
-osducli/VERSION,sha256=ZpjJE3lqnDmHmv4SwQLhYc-x2Nfi3YlnlDJwdkFsP2A,6
+osducli/VERSION,sha256=G1mbYZqgx_9E_1oendInfs1C3OixdTj3J-8x9IPDbVY,6
 osducli/__init__.py,sha256=J3RwqAbN7MWvz8vL24fMUar9Sfk8nMI8xq_aSHGXUy8,591
 osducli/__main__.py,sha256=4HonhahSaS3Un0f93qnbs_pmJ5pbbVHU-qdhsssVkB0,3661
 osducli/click_cli.py,sha256=EIe42DOnHDRKU3mPGwT12jI-yX3hsBOp_nS4nMTWc_Y,10864
@@ -70,7 +70,7 @@ osducli/commands/search/_const.py,sha256=YYTZd35Z9O0gEf6kb9Ntonvv3qArkAcszKAq2VA
 osducli/commands/search/id.py,sha256=1tVbgpDRhW08gyaLfQbCZjFrQDUGPh8gupf7pNhiN6c,1909
 osducli/commands/search/info.py,sha256=j6cjYDbxiiQEKXs0LJGQ_0scKReCGi6iQJrfn2X0B20,1333
 osducli/commands/search/kind.py,sha256=9vGVp4QG4dTII4LGcLYKDAE2PmcB-isgiCfwiITVauU,1786
-osducli/commands/search/query.py,sha256=EUHnIFvuCxAYBQK_k7YkBb8mYnedvRPMwBpeM1vj9r4,2405
+osducli/commands/search/query.py,sha256=4ifV-F3mixs0c05v7wljUdvXE9WU9LR_rjJKbTXDPds,3094
 osducli/commands/status/__init__.py,sha256=5g1PB_tU0sqP7aplnihjfhMzVVQdlB3Y01QIeHAtSMw,595
 osducli/commands/status/status.py,sha256=yh6KVUpNYbrLJIH-7GjMyo2MpR8Wvycr4KdkxUI1V5A,4543
 osducli/commands/storage/__init__.py,sha256=Ilc97Kje3VVLZIBJucd_2jsW1GF5En00xF-A6kiLAFM,585
@@ -80,7 +80,9 @@ osducli/commands/storage/delete.py,sha256=ryjrd24wiJlTAL6jIsTW1gCxB0icAMu0YIyUTx
 osducli/commands/storage/get.py,sha256=FgjoN_1cY90cbU1osh53XviGvTZaPtRjthUmtP2Y2-k,2136
 osducli/commands/storage/info.py,sha256=CGbA92GJYkWcLXHx1Z4i9g7Auk-ws2Cg6n6X7_m27iw,1345
 osducli/commands/storage/list.py,sha256=bIN76XW70Xml0CCldNvjN-qCumqICjZkQPXs7LTY69M,1413
-osducli/commands/storage/versions.py,sha256=9KtVFIofIXPjozw_haeZDx28Y5SVfbYKtOyP8Q4jxx4,1483
+osducli/commands/storage/version/__init__.py,sha256=h_BEt3whnDdxWHMNK9ej3_aQ_oWtRN41Wjr4XN9kQ6k,593
+osducli/commands/storage/version/get.py,sha256=r7_HRE5FS2HNrltyO-RsxVcAlhlmwoKmGdOMDy76w_E,1983
+osducli/commands/storage/version/list.py,sha256=F9bAHnmp-Iy2cDIjR7rT4CcPYWnrzBARC2ZEWNjg-uk,1483
 osducli/commands/unit/__init__.py,sha256=wi3jN5VORSyR-1R9p3smO6zkzejAnAI0-T9_moGSl08,582
 osducli/commands/unit/_const.py,sha256=GuBlXzsI723OKlqcBzsG21T44V_SbOPqdbaw8_c2c5s,696
 osducli/commands/unit/info.py,sha256=3mAB14C5256cDQGR_pUbSpKXN-0ohA7gxqxwq4t4VP8,1210
@@ -234,9 +236,9 @@ osducli/util/file.py,sha256=kfh6SLOI7X54gZ0hWF3kQ1npXPylNYgE1d1_w-fFyr0,1821
 osducli/util/prompt.py,sha256=0i3eNnxOHRQstvsvfiKnN0lIxXu6sEXIcU8txeYRhNs,7492
 osducli/util/pypi.py,sha256=-DW5CThkKKiOwLp2tg85BmrLKZzkMI9pu8DyWNPZH6E,1192
 osducli/util/service_info.py,sha256=YsVvoRoeG1osFjql2AgVkGoj1TePuhBZf3CQXl2a9As,2577
-osducli-0.0.50.dist-info/licenses/LICENSE.md,sha256=9xnGPjJkOAgd0kH4QLlvOIYKqY1M49gWUQpoUxAU-9Y,12788
-osducli-0.0.50.dist-info/METADATA,sha256=dZXA1t4OQiGFavpnmqNh6GqJcszqJHTNz9K8oWpEB98,6251
-osducli-0.0.50.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-osducli-0.0.50.dist-info/entry_points.txt,sha256=gASIcihV0BSJDZOUK-zTzb8RiccZCvKfVZMna9RsEIg,47
-osducli-0.0.50.dist-info/top_level.txt,sha256=lqiP5fuyH8lx7c2emYoIVZNxZAPX-bSwnMH789wxUAY,8
-osducli-0.0.50.dist-info/RECORD,,
+osducli-0.0.52.dist-info/licenses/LICENSE.md,sha256=9xnGPjJkOAgd0kH4QLlvOIYKqY1M49gWUQpoUxAU-9Y,12788
+osducli-0.0.52.dist-info/METADATA,sha256=GeVpDwPmeIaWRhbUSh3Lklw_bCDax_4lDCusbo0p2yU,6364
+osducli-0.0.52.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
+osducli-0.0.52.dist-info/entry_points.txt,sha256=gASIcihV0BSJDZOUK-zTzb8RiccZCvKfVZMna9RsEIg,47
+osducli-0.0.52.dist-info/top_level.txt,sha256=lqiP5fuyH8lx7c2emYoIVZNxZAPX-bSwnMH789wxUAY,8
+osducli-0.0.52.dist-info/RECORD,,

{osducli-0.0.50.dist-info → osducli-0.0.52.dist-info}/WHEEL

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