osducli 0.0.43__tar.gz → 0.0.45__tar.gz

{osducli-0.0.43/src/osducli.egg-info → osducli-0.0.45}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: osducli
-Version: 0.0.43
+Version: 0.0.45
 Summary: OSDU command line
 Author-email: Equinor ASA <mhew@equinor.com>
 License: Apache-2.0
@@ -17,7 +17,7 @@ Description-Content-Type: text/x-rst
 License-File: LICENSE.md
 Requires-Dist: click
 Requires-Dist: jmespath
-Requires-Dist: osdu-api[all]==0.28.0rc912
+Requires-Dist: osdu-api[all]==0.28
 Requires-Dist: requests
 Requires-Dist: tabulate
 Requires-Dist: packaging
@@ -33,8 +33,6 @@ Requires-Dist: google-cloud-storage
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
 Requires-Dist: isort; extra == "dev"
-Requires-Dist: flake8; extra == "dev"
-Requires-Dist: pep8; extra == "dev"
 Requires-Dist: pylint; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
@@ -83,6 +81,16 @@ For more information, specify the `-h` flag:
 Change Log
 ==========
 
+0.0.45
+------
+
+- Fix msal_non_interactive authentication
+
+0.0.44
+------
+
+- Fix handling of json data in put and post requests
+
 0.0.43
 ------
 

{osducli-0.0.43 → osducli-0.0.45}/README.rst

@@ -35,6 +35,16 @@ For more information, specify the `-h` flag:
 Change Log
 ==========
 
+0.0.45
+------
+
+- Fix msal_non_interactive authentication
+
+0.0.44
+------
+
+- Fix handling of json data in put and post requests
+
 0.0.43
 ------
 

{osducli-0.0.43 → osducli-0.0.45}/pyproject.toml

@@ -26,7 +26,7 @@ keywords = ["osdu"]
 dependencies = [
     "click",
     "jmespath",
-    "osdu-api[all]==0.28.0rc912",
+    "osdu-api[all]==0.28",
     "requests",
     "tabulate",
     "packaging",
@@ -54,8 +54,6 @@ dev = [
     "black",
     "isort",
     # linting
-    "flake8",
-    "pep8",
     "pylint",
     "ruff",
     # testing
@@ -93,3 +91,18 @@ src = ["src"]
 [tool.ruff.lint]
 select = ["E", "F", "W", "I", "B", "UP"]
 ignore = ["E501"]
+
+[tool.pylint."messages control"]
+disable = [
+    "missing-docstring",
+    "protected-access",
+    "too-many-arguments",
+    "too-many-locals",
+    "too-many-branches",
+    "too-many-positional-arguments",
+    "format",
+    "fixme",
+    "unknown-option-value",
+    "unspecified-encoding",
+    "broad-exception-raised"
+]

{osducli-0.0.43 → osducli-0.0.45}/src/osducli/__init__.py

@@ -12,4 +12,4 @@
 
 """ OSDU command line environment"""
 
-__VERSION__ = "0.0.43"
+__VERSION__ = "0.0.45"

{osducli-0.0.43 → osducli-0.0.45}/src/osducli/auth/credentials.py

@@ -13,7 +13,6 @@
 
 import os
 
-from msal import ConfidentialClientApplication
 from osdu_api.providers.types import BaseCredentials
 
 from osducli.auth.aws_token_credential import AwsTokenCredential
@@ -47,13 +46,11 @@ def msal_non_interactive_credentials(config) -> BaseCredentials:
     authority = config.get("core", CONFIG_AUTHENTICATION_AUTHORITY, None)
     scopes = config.get("core", CONFIG_AUTHENTICATION_SCOPES, None)
     client_secret = config.get("core", CONFIG_CLIENT_SECRET, None)
-    app = ConfidentialClientApplication(client_id, client_secret, authority)
     credentials = MsalNonInteractiveCredential(
         client_id=client_id,
         client_secret=client_secret,
         authority=authority,
         scopes=scopes,
-        client=app,
     )
     return credentials
 

{osducli-0.0.43 → osducli-0.0.45}/src/osducli/auth/msal_non_interactive.py

@@ -21,14 +21,13 @@ logger = get_logger(__name__)
 class MsalNonInteractiveCredential(BaseCredentials):
     """Get token based client for connecting with OSDU."""
 
-    __access_token = None
+    _access_token = None
 
     def __init__(self,
                  client_id: str,
                  client_secret: str,
                  authority: str,
-                 scopes: str,
-                 client: ConfidentialClientApplication):
+                 scopes: str):
         """Setup the new client
 
         Args:
@@ -37,32 +36,26 @@ class MsalNonInteractiveCredential(BaseCredentials):
             scopes (str): scopes to request
         """
         super().__init__()
-        self._msal_confidential_client = client
         self._client_id = client_id
         self._client_secret = client_secret
         self._authority = authority
         self._scopes = scopes
+        self._app = ConfidentialClientApplication(
+            self._client_id, self._client_secret, self._authority
+        )
 
     @property
     def access_token(self) -> str:
-        return self.__access_token
+        return self._access_token
 
-    def refresh_token(self) -> str:   # pylint: disable=inconsistent-return-statements
+    def refresh_token(self) -> str:
         """
         return access_token.
         """
-        token = self._get_token()
-        if 'access_token' in token:
-            __access_token = token['access_token']
-            return __access_token
+        response = self._app.acquire_token_for_client(scopes=[self._scopes])
+        if 'access_token' in response:
+            self._access_token = response['access_token']
+        else:
+            raise Exception("Failed to aquire token")
 
-    def _get_token(self) -> dict:
-        """Get token using msal confidential client.
-
-         Returns:
-            dict: Dictionary representing the returned token
-        """
-        result = self._msal_confidential_client.acquire_token_silent([self._scopes], account=None)
-        if result:
-            return result
-        return self._msal_confidential_client.acquire_token_for_client([self._scopes])
+        return self._access_token

{osducli-0.0.43 → osducli-0.0.45}/src/osducli/cliclient.py

@@ -157,12 +157,14 @@ class CliOsduClient(BaseClient):
         return url
 
     def check_status_code(self, response: requests.Response, ok_status_codes: list = None):
+        """Check the status code of the response and raise an exception if not in the list of ok status codes"""
         if ok_status_codes is None:
             ok_status_codes = [200]
         if response.status_code not in ok_status_codes:
             raise HTTPError(response=response)
 
     def get_search_client(self) -> SearchClient:
+        """Get a client for the search service"""
         search_url = self.url_from_config(CONFIG_SEARCH_URL, "")
         if search_url.endswith("/"):
             search_url = search_url[:-1]
@@ -174,6 +176,7 @@ class CliOsduClient(BaseClient):
         )
 
     def get_storage_record_client(self) -> RecordClient:
+        """Get a client for the storage record service"""
         storage_url = self.url_from_config(CONFIG_STORAGE_URL, "")
         if storage_url.endswith("/"):
             storage_url = storage_url[:-1]
@@ -185,6 +188,7 @@ class CliOsduClient(BaseClient):
         )
 
     def get_entitlements_client(self) -> EntitlementsClient:
+        """Get a client for the entitlements service"""
         entitlements_url = self.url_from_config(CONFIG_ENTITLEMENTS_URL, "")
         if entitlements_url.endswith("/"):
             entitlements_url = entitlements_url[:-1]
@@ -195,7 +199,15 @@ class CliOsduClient(BaseClient):
             token_refresher=self.token_refresher
         )
 
-    def get_wellbore_ddms_client(self, url_extra_path: str) -> WellboreDdmsClient:
+    def get_wellbore_ddms_client(
+        self,
+        url_extra_path: str
+    ) -> WellboreDdmsClient:
+        """Get a client for the wellbore ddms service
+
+        Args:
+            url_extra_path (str): extra path to add to the base path
+        """
         wellbore_ddms_url = self.url_from_config(CONFIG_WELLBORE_DDMS_URL, url_extra_path)
         return WellboreDdmsClient(
             wellbore_ddms_url=wellbore_ddms_url,
@@ -205,9 +217,12 @@ class CliOsduClient(BaseClient):
         )
 
     def cli_get(
-        self, config_url_key: str, url_extra_path: str, ok_status_codes: list = None
+        self,
+        config_url_key: str,
+        url_extra_path: str,
+        ok_status_codes: list = None
     ) -> requests.Response:
-        """[summary]
+        """Basic GET call to the given url, returning the response object.
 
         Args:
             config_url_key (str): key in configuration for the base path
@@ -220,9 +235,12 @@ class CliOsduClient(BaseClient):
         return response
 
     def cli_get_returning_json(
-        self, config_url_key: str, url_extra_path: str, ok_status_codes: list = None
+        self,
+        config_url_key: str,
+        url_extra_path: str,
+        ok_status_codes: list = None
     ) -> dict:
-        """[summary]
+        """Basic GET call to the given url, returning the json.
 
         Args:
             config_url_key (str): key in configuration for the base path
@@ -241,7 +259,7 @@ class CliOsduClient(BaseClient):
         data: str | dict,
         ok_status_codes: list = None,
     ) -> dict:
-        """[summary]
+        """Basic POST call to the given url, returning the json.
 
         Args:
             config_url_key (str): key in configuration for the base path
@@ -253,6 +271,8 @@ class CliOsduClient(BaseClient):
             dict: returned json
         """
         url = self.url_from_config(config_url_key, url_extra_path)
+        if isinstance(data, dict):
+            data = json.dumps(data)
         response = self.make_request(method=HttpMethod.POST, url=url, data=data)
         self.check_status_code(response, ok_status_codes)
         return response.json()
@@ -263,7 +283,7 @@ class CliOsduClient(BaseClient):
         url_extra_path: str,
         ok_status_codes: list = None,
     ) -> requests.Response:
-        """[summary]
+        """Basic DELETE call to the given url.
 
         Args:
             config_url_key (str): key in configuration for the base path
@@ -289,7 +309,7 @@ class CliOsduClient(BaseClient):
         data: str | dict,
         ok_status_codes: list = None,
     ) -> requests.Response:
-        """[summary]
+        """Basic PUT call to the given url.
 
         Args:
             config_url_key (str): key in configuration for the base path
@@ -298,6 +318,8 @@ class CliOsduClient(BaseClient):
             ok_status_codes (list, optional): Optional status codes to check for successful call.
         """
         url = self.url_from_config(config_url_key, url_extra_path)
+        if isinstance(data, dict):
+            data = json.dumps(data)
         response = self.make_request(method=HttpMethod.PUT, url=url, data=data)
         self.check_status_code(response, ok_status_codes)
         return response
@@ -309,7 +331,7 @@ class CliOsduClient(BaseClient):
         data: str | dict,
         ok_status_codes: list = None,
     ) -> dict:
-        """PUT the data to the given url.
+        """Basic PUT call to the given url, returning the json.
 
         Args:
             config_url_key (str): key in configuration for the base path
@@ -321,6 +343,8 @@ class CliOsduClient(BaseClient):
             dict: returned json
         """
         url = self.url_from_config(config_url_key, url_extra_path)
+        if isinstance(data, dict):
+            data = json.dumps(data)
         response = self.make_request(method=HttpMethod.PUT, url=url, data=data)
         self.check_status_code(response, ok_status_codes)
         return response.json()

{osducli-0.0.43 → osducli-0.0.45}/src/osducli/commands/wellbore_ddms/_const.py

@@ -16,3 +16,4 @@ WELLBORE_DDMS_SERVICE_NAME = "Wellbore DDMS service"
 WELLBORE_DDMS_STATUS_PATH = "/about"
 WELLBORE_DDMS_SWAGGER_PATH = "https://community.opengroup.org/osdu/platform/domain-data-mgmt-services/wellbore/wellbore-domain-services/-/blob/master/spec/generated/openapi.json"  # noqa: E501
 WELLBORE_DDMS_DOCUMENTATION = "https://community.opengroup.org/osdu/platform/domain-data-mgmt-services/wellbore/wellbore-domain-services/-/tree/master"  # noqa: E501
+WELLBORE_DDMS_WELL_LOG_PATH = "/ddms/v3/welllogs"

osducli-0.0.45/src/osducli/commands/wellbore_ddms/well_log/add.py

@@ -0,0 +1,42 @@
+#  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.
+"""Well Log add record command"""
+import json
+
+import click
+
+from osducli.click_cli import CustomClickCommand, State, command_with_output
+from osducli.cliclient import CliOsduClient, handle_cli_exceptions
+from osducli.commands.wellbore_ddms._const import WELLBORE_DDMS_WELL_LOG_PATH
+
+
+# click entry point
+@click.command(cls=CustomClickCommand, help="Add Well Log record")
+@click.option("-f", "--file", "_file", help="WellLog record file to add", required=True)
+@handle_cli_exceptions
+@command_with_output("recordIds")
+def _click_command(state: State, _file: str):
+    return add_record(state, _file)
+
+
+def add_record(state: State, record_file: str):
+    """Add Well Log record"""
+    client = CliOsduClient(state.config)
+    wellbore_client = client.get_wellbore_ddms_client(url_extra_path=WELLBORE_DDMS_WELL_LOG_PATH)
+
+    with open(record_file) as file:
+        record_data = json.load(file)
+
+    record_data_list = "[" + json.dumps(record_data) + "]"
+    response = wellbore_client.create_well_log(record_data_list)
+    client.check_status_code(response)
+    return response.json()

osducli-0.0.45/src/osducli/commands/wellbore_ddms/well_log/data/__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.
+
+"""Wellbore DDMS Well Log data commands"""

osducli-0.0.45/src/osducli/commands/wellbore_ddms/well_log/data/add.py

@@ -0,0 +1,40 @@
+#  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.
+"""Well Log add data command"""
+import click
+
+from osducli.click_cli import CustomClickCommand, State, command_with_output
+from osducli.cliclient import CliOsduClient, handle_cli_exceptions
+from osducli.commands.wellbore_ddms._const import WELLBORE_DDMS_WELL_LOG_PATH
+
+
+# click entry point
+@click.command(cls=CustomClickCommand, help="Add Well Log data")
+@click.option("-id", "--id", "_id", help="WellLog id to add data to", required=True)
+@click.option("-f", "--file", "_file", help="WellLog data file to add", required=True)
+@handle_cli_exceptions
+@command_with_output("recordIds")
+def _click_command(state: State, _id: str, _file: str):
+    return add_data(state, _id, _file)
+
+
+def add_data(state: State, identifier: str, data_file: str):
+    """Well Log add data"""
+    client = CliOsduClient(state.config)
+    wellbore_client = client.get_wellbore_ddms_client(url_extra_path=WELLBORE_DDMS_WELL_LOG_PATH)
+
+    with open(data_file, 'rb') as file:
+        file_data = file.read()
+
+    response = wellbore_client.create_well_log_data(identifier, file_data)
+    client.check_status_code(response)
+    return response.json()

osducli-0.0.43/src/osducli/commands/wellbore_ddms/well_log/data.py → osducli-0.0.45/src/osducli/commands/wellbore_ddms/well_log/data/get.py

@@ -16,10 +16,11 @@ import click
 
 from osducli.click_cli import CustomClickCommand, State, command_with_output
 from osducli.cliclient import CliOsduClient, handle_cli_exceptions
+from osducli.commands.wellbore_ddms._const import WELLBORE_DDMS_WELL_LOG_PATH
 
 
 # click entry point
-@click.command(cls=CustomClickCommand)
+@click.command(cls=CustomClickCommand, help="Get Well Log data by id")
 @click.option("-id", "--id", "_id", help="WellLog id to search for", required=True)
 @click.option("-f", "--file", "_file", help="File to save WellLog data", required=True)
 @handle_cli_exceptions
@@ -28,14 +29,14 @@ def _click_command(state: State, _id: str, _file: str):
     return get_data(state, _id, _file)
 
 
-def get_data(state: State, identifier: str, _file: str):
+def get_data(state: State, identifier: str, out_file: str):
     """Get Well Log record by id"""
     client = CliOsduClient(state.config)
-    wellbore_client = client.get_wellbore_ddms_client(url_extra_path="/ddms/v3/welllogs")
+    wellbore_client = client.get_wellbore_ddms_client(url_extra_path=WELLBORE_DDMS_WELL_LOG_PATH)
     response = wellbore_client.get_well_log_data(identifier)
     client.check_status_code(response)
 
-    with open(_file, 'wb') as file:
+    with open(out_file, 'wb') as file:
         file.write(response.content)
 
     filename = os.path.abspath(file.name)

osducli-0.0.43/src/osducli/commands/wellbore_ddms/well_log/record.py → osducli-0.0.45/src/osducli/commands/wellbore_ddms/well_log/get.py

@@ -14,10 +14,11 @@ import click
 
 from osducli.click_cli import CustomClickCommand, State, command_with_output
 from osducli.cliclient import CliOsduClient, handle_cli_exceptions
+from osducli.commands.wellbore_ddms._const import WELLBORE_DDMS_WELL_LOG_PATH
 
 
 # click entry point
-@click.command(cls=CustomClickCommand)
+@click.command(cls=CustomClickCommand, help="Get Well Log record by id")
 @click.option("-id", "--id", "_id", help="WellLog id to search for", required=True)
 @handle_cli_exceptions
 @command_with_output()
@@ -28,7 +29,7 @@ def _click_command(state: State, _id: str):
 def get_record(state: State, identifier: str):
     """Get Well Log record by id"""
     client = CliOsduClient(state.config)
-    wellbore_client = client.get_wellbore_ddms_client(url_extra_path="/ddms/v3/welllogs")
+    wellbore_client = client.get_wellbore_ddms_client(url_extra_path=WELLBORE_DDMS_WELL_LOG_PATH)
     response = wellbore_client.get_well_log(identifier)
     client.check_status_code(response)
     return response.json()

{osducli-0.0.43 → osducli-0.0.45/src/osducli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: osducli
-Version: 0.0.43
+Version: 0.0.45
 Summary: OSDU command line
 Author-email: Equinor ASA <mhew@equinor.com>
 License: Apache-2.0
@@ -17,7 +17,7 @@ Description-Content-Type: text/x-rst
 License-File: LICENSE.md
 Requires-Dist: click
 Requires-Dist: jmespath
-Requires-Dist: osdu-api[all]==0.28.0rc912
+Requires-Dist: osdu-api[all]==0.28
 Requires-Dist: requests
 Requires-Dist: tabulate
 Requires-Dist: packaging
@@ -33,8 +33,6 @@ Requires-Dist: google-cloud-storage
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
 Requires-Dist: isort; extra == "dev"
-Requires-Dist: flake8; extra == "dev"
-Requires-Dist: pep8; extra == "dev"
 Requires-Dist: pylint; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
@@ -83,6 +81,16 @@ For more information, specify the `-h` flag:
 Change Log
 ==========
 
+0.0.45
+------
+
+- Fix msal_non_interactive authentication
+
+0.0.44
+------
+
+- Fix handling of json data in put and post requests
+
 0.0.43
 ------
 

{osducli-0.0.43 → osducli-0.0.45}/src/osducli.egg-info/SOURCES.txt

@@ -98,8 +98,11 @@ src/osducli/commands/wellbore_ddms/__init__.py
 src/osducli/commands/wellbore_ddms/_const.py
 src/osducli/commands/wellbore_ddms/info.py
 src/osducli/commands/wellbore_ddms/well_log/__init__.py
-src/osducli/commands/wellbore_ddms/well_log/data.py
-src/osducli/commands/wellbore_ddms/well_log/record.py
+src/osducli/commands/wellbore_ddms/well_log/add.py
+src/osducli/commands/wellbore_ddms/well_log/get.py
+src/osducli/commands/wellbore_ddms/well_log/data/__init__.py
+src/osducli/commands/wellbore_ddms/well_log/data/add.py
+src/osducli/commands/wellbore_ddms/well_log/data/get.py
 src/osducli/commands/workflow/__init__.py
 src/osducli/commands/workflow/_const.py
 src/osducli/commands/workflow/get.py

{osducli-0.0.43 → osducli-0.0.45}/src/osducli.egg-info/requires.txt

@@ -1,6 +1,6 @@
 click
 jmespath
-osdu-api[all]==0.28.0rc912
+osdu-api[all]==0.28
 requests
 tabulate
 packaging
@@ -17,8 +17,6 @@ google-cloud-storage
 [dev]
 black
 isort
-flake8
-pep8
 pylint
 ruff
 pytest

{osducli-0.0.43 → osducli-0.0.45}/tests/test_cliclient.py

@@ -12,6 +12,7 @@
 
 """Test cases for CliOsduClient"""
 
+import json
 from unittest.mock import MagicMock, Mock
 
 import pytest
@@ -159,6 +160,8 @@ def test_cli_put(mocker, cli_client, config, path, data):
     response = cli_client.cli_put(config, path, data)
 
     mock_put.assert_called_once()
+    if isinstance(data, dict):
+        data = json.dumps(data)
     mock_put.assert_called_with(method=HttpMethod.PUT, url="https://dummy.com/core_" + config + path, data=data)
     assert response_mock == response
 

{osducli-0.0.43 → osducli-0.0.45}/tests/test_help_text.py

@@ -92,11 +92,11 @@ def _validate_output_read_line(
             subgroups_index += 1
 
         else:
-            assert False, f"Found unknown command {first_word_of_line}."
+            raise AssertionError(f"Found unknown command {first_word_of_line}.")
 
         return subgroups_index, commands_index
 
-    assert False, f"Section name {section} is not supported"
+    raise AssertionError(f"Section name {section} is not supported")
     # The following line will be reached. It is added so pylint does not complain
     # about inconsistent-return-statements.
     return subgroups_index, commands_index
@@ -194,7 +194,7 @@ def validate_output(
             assert b"" == err, "ERROR: in command: " + help_command
 
         if not returned_string:
-            assert False, "No help text in command: " + help_command
+            raise AssertionError("No help text in command: " + help_command)
 
         returned_string = returned_string.decode("utf-8")
         lines = returned_string.splitlines()
@@ -260,9 +260,9 @@ def validate_output(
 
     except BaseException as exception:  # pylint: disable=broad-except
         if not err:
-            assert False, f"ERROR: Command {help_command} returned error at execution. Output: {returned_string} Error: {str(exception)}"
+            raise AssertionError(f"ERROR: Command {help_command} returned error at execution. Output: {returned_string} Error: {str(exception)}") from exception
         else:
-            assert False, f"ERROR: Command {help_command} returned error at execution. Output: {returned_string} Error: {err}"
+            raise AssertionError(f"ERROR: Command {help_command} returned error at execution. Output: {returned_string} Error: {err}") from err
 
 
 

{osducli-0.0.43 → osducli-0.0.45}/src/osducli/util/file.py

@@ -11,8 +11,8 @@
 #  limitations under the License.
 
 import errno
-import os
 import glob
+import os
 
 
 def get_files_from_path(path: str) -> list: