osducli 0.0.49__tar.gz → 0.0.51__tar.gz

{osducli-0.0.49/src/osducli.egg-info → osducli-0.0.51}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: osducli
-Version: 0.0.49
+Version: 0.0.51
 Summary: OSDU command line
 Author-email: Equinor ASA <mhew@equinor.com>
 License-Expression: Apache-2.0
@@ -75,6 +75,15 @@ For more information, specify the `-h` flag:
 Change Log
 ==========
 
+0.0.51
+------
+- Get record version command
+- Aggregate by in search query
+
+0.0.50
+------
+- Maintenance release
+
 0.0.49
 ------
 - Added commands for Wellbore DDMS API

{osducli-0.0.49 → osducli-0.0.51}/README.rst

@@ -28,6 +28,15 @@ For more information, specify the `-h` flag:
 Change Log
 ==========
 
+0.0.51
+------
+- Get record version command
+- Aggregate by in search query
+
+0.0.50
+------
+- Maintenance release
+
 0.0.49
 ------
 - Added commands for Wellbore DDMS API

osducli-0.0.51/src/osducli/VERSION

@@ -0,0 +1 @@
+0.0.51

{osducli-0.0.49 → osducli-0.0.51}/src/osducli/commands/search/query.py

@@ -32,14 +32,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):
+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 +49,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,7 +61,7 @@ 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)

osducli-0.0.51/src/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-0.0.51/src/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-0.0.49/src/osducli/commands/storage/versions.py → osducli-0.0.51/src/osducli/commands/storage/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.49 → osducli-0.0.51}/src/osducli/commands/wbdutil/config_file.py

@@ -38,9 +38,9 @@ def get_config_path(config: CLIConfig,
                 "owners": [config.get('core', 'acl_owner')]
             }
         },
-        "wellbore_mapping": { get_mapping(wellbore_mapping_file) },
-        "welllog_mapping": { get_mapping(welllog_mapping_file) },
-        "las_file_mapping": { get_mapping(las_mapping_file) }
+        "wellbore_mapping": get_mapping(wellbore_mapping_file),
+        "welllog_mapping": get_mapping(welllog_mapping_file),
+        "las_file_mapping": get_mapping(las_mapping_file)
     }
     with tempfile.NamedTemporaryFile('w', delete=False, suffix='.json') as tmp:
         json.dump(output, tmp, indent=4)

{osducli-0.0.49 → osducli-0.0.51}/src/osducli/commands/wellbore_ddms/ppfgdataset/session/update.py

@@ -21,17 +21,17 @@ from osducli.commands.wellbore_ddms._const import WELLBORE_DDMS_PPFGDATASET_PATH
 @click.command(cls=CustomClickCommand, help="Update a session, either commit or abandon")
 @click.option("-id", "--id", "_id", help="PPFG Dataset id to update", required=True)
 @click.option("-s", "--session", "_ses", help="PPFG Dataset session id to update", required=True)
-@click.option("-c", "--commit", "_com", is_flag=True, help="Commit or abandon", required=False)
+@click.option("-a", "--abandon", "_aba", is_flag=True, help="Abandon session. Will commit session if flag is omitted", required=False)
 @handle_cli_exceptions
 @command_with_output()
-def _click_command(state: State, _id: str, _ses: str, _com: bool):
-    return update_session(state, _id, _ses, _com)
+def _click_command(state: State, _id: str, _ses: str, _aba: bool):
+    return update_session(state, _id, _ses, _aba)
 
 
-def update_session(state: State, record_id: str, session_id: str, commit: bool):
+def update_session(state: State, record_id: str, session_id: str, abandon: bool = False):
     """Update a session, either commit or abandon"""
     client = CliOsduClient(state.config)
     wellbore_client = client.get_wellbore_ddms_client(url_extra_path=WELLBORE_DDMS_PPFGDATASET_PATH)
-    response = wellbore_client.update_wbddms_session(record_id, session_id, commit)
+    response = wellbore_client.update_wbddms_session(record_id, session_id, abandon)
     client.check_status_code(response)
     return response.json()

{osducli-0.0.49 → osducli-0.0.51}/src/osducli/commands/wellbore_ddms/trajectory/session/update.py

@@ -21,17 +21,17 @@ from osducli.commands.wellbore_ddms._const import WELLBORE_DDMS_TRAJECTORY_PATH
 @click.command(cls=CustomClickCommand, help="Update a session, either commit or abandon")
 @click.option("-id", "--id", "_id", help="Wellbore Trajectory id to update", required=True)
 @click.option("-s", "--session", "_ses", help="Wellbore Trajectory session id to update", required=True)
-@click.option("-c", "--commit", "_com", is_flag=True, help="Commit or abandon", required=False)
+@click.option("-a", "--abandon", "_aba", is_flag=True, help="Abandon session. Will commit session if flag is omitted", required=False)
 @handle_cli_exceptions
 @command_with_output()
-def _click_command(state: State, _id: str, _ses: str, _com: bool):
-    return update_session(state, _id, _ses, _com)
+def _click_command(state: State, _id: str, _ses: str, _aba: bool):
+    return update_session(state, _id, _ses, _aba)
 
 
-def update_session(state: State, record_id: str, session_id: str, commit: bool):
+def update_session(state: State, record_id: str, session_id: str, abandon: bool = False):
     """Update a session, either commit or abandon"""
     client = CliOsduClient(state.config)
     wellbore_client = client.get_wellbore_ddms_client(url_extra_path=WELLBORE_DDMS_TRAJECTORY_PATH)
-    response = wellbore_client.update_wbddms_session(record_id, session_id, commit)
+    response = wellbore_client.update_wbddms_session(record_id, session_id, abandon)
     client.check_status_code(response)
     return response.json()

{osducli-0.0.49 → osducli-0.0.51}/src/osducli/commands/wellbore_ddms/well_log/data/statistics.py

@@ -20,7 +20,7 @@ from osducli.commands.wellbore_ddms._const import WELLBORE_DDMS_WELL_LOG_PATH
 # click entry point
 @click.command(cls=CustomClickCommand, help="Get WellLog data statistics by id")
 @click.option("-id", "--id", "_id", help="WellLog id to search for", required=True)
-@click.option("-c", "--curves", "_curves", help="List of curves or array to be returned. All curves if empty", required=False)
+@click.option("-cu", "--curves", "_curves", help="List of curves or array to be returned. All curves if empty", required=False)
 @handle_cli_exceptions
 @command_with_output()
 def _click_command(state: State, _id: str, _curves: str):

{osducli-0.0.49 → osducli-0.0.51}/src/osducli/commands/wellbore_ddms/well_log/session/update.py

@@ -21,17 +21,17 @@ from osducli.commands.wellbore_ddms._const import WELLBORE_DDMS_WELL_LOG_PATH
 @click.command(cls=CustomClickCommand, help="Update a session, either commit or abandon")
 @click.option("-id", "--id", "_id", help="WellLog id to update", required=True)
 @click.option("-s", "--session", "_ses", help="WellLog session id to update", required=True)
-@click.option("-c", "--commit", "_com", is_flag=True, help="Commit or abandon", required=False)
+@click.option("-a", "--abandon", "_aba", is_flag=True, help="Abandon session. Will commit session if flag is omitted", required=False)
 @handle_cli_exceptions
 @command_with_output()
-def _click_command(state: State, _id: str, _ses: str, _com: bool):
-    return update_session(state, _id, _ses, _com)
+def _click_command(state: State, _id: str, _ses: str, _aba: bool):
+    return update_session(state, _id, _ses, _aba)
 
 
-def update_session(state: State, record_id: str, session_id: str, commit: bool):
+def update_session(state: State, record_id: str, session_id: str, abandon: bool = False):
     """Update a session, either commit or abandon"""
     client = CliOsduClient(state.config)
     wellbore_client = client.get_wellbore_ddms_client(url_extra_path=WELLBORE_DDMS_WELL_LOG_PATH)
-    response = wellbore_client.update_wbddms_session(record_id, session_id, commit)
+    response = wellbore_client.update_wbddms_session(record_id, session_id, abandon)
     client.check_status_code(response)
     return response.json()

{osducli-0.0.49 → osducli-0.0.51}/src/osducli/commands/wellbore_ddms/well_log/version/data/statistics.py

@@ -21,7 +21,7 @@ from osducli.commands.wellbore_ddms._const import WELLBORE_DDMS_WELL_LOG_PATH
 @click.command(cls=CustomClickCommand, help="Get WellLog data statistics by id and version")
 @click.option("-id", "--id", "_id", help="WellLog id to search for", required=True)
 @click.option("-v", "--version", "_ver", help="WellLog version to search for", required=True)
-@click.option("-c", "--curves", "_curves", help="List of curves or array to be returned. All curves if empty", required=False)
+@click.option("-cu", "--curves", "_curves", help="List of curves or array to be returned. All curves if empty", required=False)
 @handle_cli_exceptions
 @command_with_output()
 def _click_command(state: State, _id: str, _ver: str, _curves: str):

{osducli-0.0.49 → osducli-0.0.51}/src/osducli/commands/wellbore_ddms/wellpressure_test_raw_measurement/session/update.py

@@ -23,17 +23,17 @@ from osducli.commands.wellbore_ddms._const import (
 @click.command(cls=CustomClickCommand, help="Update a session, either commit or abandon")
 @click.option("-id", "--id", "_id", help="Wellpressure Test Raw Measurement id to update", required=True)
 @click.option("-s", "--session", "_ses", help="Wellpressure Test Raw Measurement session id to update", required=True)
-@click.option("-c", "--commit", "_com", is_flag=True, help="Commit or abandon", required=False)
+@click.option("-a", "--abandon", "_aba", is_flag=True, help="Abandon session. Will commit session if flag is omitted", required=False)
 @handle_cli_exceptions
 @command_with_output()
-def _click_command(state: State, _id: str, _ses: str, _com: bool):
-    return update_session(state, _id, _ses, _com)
+def _click_command(state: State, _id: str, _ses: str, _aba: bool):
+    return update_session(state, _id, _ses, _aba)
 
 
-def update_session(state: State, record_id: str, session_id: str, commit: bool):
+def update_session(state: State, record_id: str, session_id: str, abandon: bool = False):
     """Update a session, either commit or abandon"""
     client = CliOsduClient(state.config)
     wellbore_client = client.get_wellbore_ddms_client(url_extra_path=WELLBORE_DDMS_WELLPRESSURE_TEST_RAW_MEASUREMENT_PATH)
-    response = wellbore_client.update_wbddms_session(record_id, session_id, commit)
+    response = wellbore_client.update_wbddms_session(record_id, session_id, abandon)
     client.check_status_code(response)
     return response.json()

{osducli-0.0.49 → osducli-0.0.51}/src/osducli/wbddms_client.py

@@ -126,9 +126,9 @@ class WellboreDdmsClient(BaseClient):
             url=f"{self.wellbore_ddms_url}/{record_id}/sessions/{session_id}"
         )
 
-    def update_wbddms_session(self, record_id: str, session_id: str, commit: bool = True) -> requests.Response:
+    def update_wbddms_session(self, record_id: str, session_id: str, abandon: bool = False) -> requests.Response:
         """Update a session, either commit or abandon"""
-        data = '{"state": ' + ('commit' if commit else 'abandon') + '}'
+        data = {"state": ("abandon" if abandon else "commit")}
         return self.make_request(
             method=HttpMethod.PATCH,
             url=f"{self.wellbore_ddms_url}/{record_id}/sessions/{session_id}",

{osducli-0.0.49 → osducli-0.0.51/src/osducli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: osducli
-Version: 0.0.49
+Version: 0.0.51
 Summary: OSDU command line
 Author-email: Equinor ASA <mhew@equinor.com>
 License-Expression: Apache-2.0
@@ -75,6 +75,15 @@ For more information, specify the `-h` flag:
 Change Log
 ==========
 
+0.0.51
+------
+- Get record version command
+- Aggregate by in search query
+
+0.0.50
+------
+- Maintenance release
+
 0.0.49
 ------
 - Added commands for Wellbore DDMS API

{osducli-0.0.49 → osducli-0.0.51}/src/osducli.egg-info/SOURCES.txt

@@ -90,7 +90,9 @@ src/osducli/commands/storage/delete.py
 src/osducli/commands/storage/get.py
 src/osducli/commands/storage/info.py
 src/osducli/commands/storage/list.py
-src/osducli/commands/storage/versions.py
+src/osducli/commands/storage/version/__init__.py
+src/osducli/commands/storage/version/get.py
+src/osducli/commands/storage/version/list.py
 src/osducli/commands/unit/__init__.py
 src/osducli/commands/unit/_const.py
 src/osducli/commands/unit/info.py

{osducli-0.0.49 → osducli-0.0.51}/tests/test_help_text.py

@@ -363,7 +363,12 @@ def test_help_documentation():
 
     validate_output(
         "osdu storage",
-        commands=("add", "delete", "get", "info", "list", "versions"),
+        commands=("add", "delete", "get", "info", "list", "version"),
+    )
+
+    validate_output(
+        "osdu storage version",
+        commands=("get", "list"),
     )
 
     validate_output(

osducli-0.0.49/src/osducli/VERSION

@@ -1 +0,0 @@
-0.0.49