hdpws 0.6.18__tar.gz → 0.6.22__tar.gz

{hdpws-0.6.18 → hdpws-0.6.22}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hdpws
-Version: 0.6.18
+Version: 0.6.22
 Summary: NASA's Heliophysics Data Portal Web Service Client Library
 Home-page: https://heliophysicsdata.gsfc.nasa.gov/WebServices
 Author: Bernie Harris
@@ -44,13 +44,11 @@ To run the included example, do the following
 
 ---
 
-The following [Jupyter notebooks](https://jupyter.org/) demonstrate
+Also, the following [Jupyter notebooks](https://jupyter.org/) demonstrate
 different features of the library:
-1. [Simple Query Example](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExample.html) ([ipynb file](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExample.ipynb))demonstrating a simple query.
-2. [Example with data retrieval](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExampleWithCdasWs.html) using [cdasws](https://pypi.org/project/cdasws/) ([ipynb file](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExampleWithCdasWs.ipynb)).
+1. [Simple Query Example](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExample.html) ([ipynb file](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExample.ipynb)) demonstrating a simple query. [Launch on Binder](https://mybinder.org/v2/gh/berniegsfc/hdpws-notebooks/main?labpath=HdpWsExample.ipynb).
+2. [Example with data retrieval](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExampleWithCdasWs.html) using [cdasws](https://pypi.org/project/cdasws/) ([ipynb file](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExampleWithCdasWs.ipynb)).  [Launch on Binder](https://mybinder.org/v2/gh/berniegsfc/hdpws-notebooks/main?labpath=HdpWsExampleWithCdasWs.ipynb).
 
-These notebooks will eventually be available on 
-[Binder](https://mybinder.org/v2/gh/berniegsfc/hdpws-notebooks/main).
 
 ## Motivation
 

{hdpws-0.6.18 → hdpws-0.6.22}/README.md

@@ -20,13 +20,11 @@ To run the included example, do the following
 
 ---
 
-The following [Jupyter notebooks](https://jupyter.org/) demonstrate
+Also, the following [Jupyter notebooks](https://jupyter.org/) demonstrate
 different features of the library:
-1. [Simple Query Example](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExample.html) ([ipynb file](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExample.ipynb))demonstrating a simple query.
-2. [Example with data retrieval](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExampleWithCdasWs.html) using [cdasws](https://pypi.org/project/cdasws/) ([ipynb file](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExampleWithCdasWs.ipynb)).
+1. [Simple Query Example](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExample.html) ([ipynb file](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExample.ipynb)) demonstrating a simple query. [Launch on Binder](https://mybinder.org/v2/gh/berniegsfc/hdpws-notebooks/main?labpath=HdpWsExample.ipynb).
+2. [Example with data retrieval](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExampleWithCdasWs.html) using [cdasws](https://pypi.org/project/cdasws/) ([ipynb file](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExampleWithCdasWs.ipynb)).  [Launch on Binder](https://mybinder.org/v2/gh/berniegsfc/hdpws-notebooks/main?labpath=HdpWsExampleWithCdasWs.ipynb).
 
-These notebooks will eventually be available on 
-[Binder](https://mybinder.org/v2/gh/berniegsfc/hdpws-notebooks/main).
 
 ## Motivation
 

{hdpws-0.6.18 → hdpws-0.6.22}/hdpws/__init__.py

@@ -24,7 +24,7 @@
 #
 # NOSA HEADER END
 #
-# Copyright (c) 2023 United States Government as represented by
+# Copyright (c) 2023-2024 United States Government as represented by
 # the National Aeronautics and Space Administration. No copyright is
 # claimed in the United States under Title 17, U.S.Code. All Other
 # Rights Reserved.
@@ -34,14 +34,14 @@
 Package for accessing the NASA's Heliophysics Data Portal (HDP) web
 services https://heliophysicsdata.gsfc.nasa.gov/WebServices/.
 
-Copyright © 2023 United States Government as represented by the
+Copyright © 2023-2024 United States Government as represented by the
 National Aeronautics and Space Administration. No copyright is claimed in
 the United States under Title 17, U.S.Code. All Other Rights Reserved.
 
 """
 
 
-__version__ = "0.6.18"
+__version__ = "0.6.22"
 
 
 #

{hdpws-0.6.18 → hdpws-0.6.22}/hdpws/__main__.py

@@ -147,6 +147,14 @@ def example(
                 disable_ssl_certificate_validation, user_agent='Example')
 
 
+    result = hdp.get_application_interfaces()
+    if result['HttpStatus'] == 200:
+        print('HDP ApplicationInterfaces:')
+        for value in result['ApplicationInterface']:
+            print(f'    {value}')
+    else:
+        print_error('hdp.get_application_interfaces', result)
+
     result = hdp.get_keywords()
     if result['HttpStatus'] == 200:
         print('HDP Keywords:')
@@ -395,6 +403,27 @@ def example(
         print_error('hdp.get_spase_document', result)
 
 
+    query = {
+        'ResourceID': 'spase://CCMC/Software/Kamodo',
+        'CodeLanguage': 'Python',
+        'Description': '"space weather models and data"'
+    }
+
+
+    if result['HttpStatus'] == 200:
+        #print('HDP Spase:')
+        #print(ET.tostring(result['Result']))
+        print('Result Software:')
+        for software in result['Result'].findall('.//Software', namespaces=NS):
+            print(software.findall('.//ResourceID', namespaces=NS)[0].text)
+            print('    ', software.findall('.//ResourceName', namespaces=NS)[0].text)
+            #ET.indent(software)
+            #print(ET.tostring(software, encoding='unicode',
+            #                  default_namespace=SPASE_NS))
+    else:
+        print_error('hdp.get_spase_software', result)
+
+
 def print_error(
         label: str,
         result: Dict

{hdpws-0.6.18 → hdpws-0.6.22}/hdpws/hdpws.py

@@ -24,7 +24,7 @@
 #
 # NOSA HEADER END
 #
-# Copyright (c) 2023 United States Government as represented by
+# Copyright (c) 2023-2024 United States Government as represented by
 # the National Aeronautics and Space Administration. No copyright is
 # claimed in the United States under Title 17, U.S.Code. All Other
 # Rights Reserved.
@@ -197,6 +197,33 @@ class HdpWs:
         return self._endpoint
 
 
+    def get_application_interfaces(
+            self
+        ) -> Dict:
+        """
+        Gets all /Spase/Software/ApplicationInterface values available at HDP.
+
+        Returns
+        -------
+        Dict
+            Dictionary containing a 'ApplicationInterface' key with a value
+            of a List containing all /Spase/Software/ApplicationInterface values
+            with the addition of the following key/values:<br>
+            - HttpStatus: with the value of the HTTP status code.
+              Successful == 200.<br>
+            When HttpStatus != 200:<br>
+            - HttpText: containing a string representation of the HTTP
+              entity body.<br>
+            When HttpText is a standard HDP WS error entity body the
+            following key/values (convenience to avoid parsing
+            HttpStatus):<br>
+            - ErrorMessage: value from HttpText.<br>
+            - ErrorDescription: value from HttpText.<br>
+        """
+        return self.__get_simple_resource('Spase/ApplicationInterface',
+                                          'ApplicationInterface', 
+                                          'ApplicationInterface')
+
     def get_keywords(
             self
         ) -> Dict:
@@ -818,6 +845,83 @@ class HdpWs:
         return self.__get_complex_resource([ResourceType.DOCUMENT], query)
 
 
+    def get_spase_service(
+            self,
+            query: Dict
+        ) -> Dict:
+        """
+        Gets the specified SPASE Service documents from HDP.
+
+        Parameters
+        ----------
+        query
+            Dictionary containing query parameters and values.  For
+            example,<pre>
+            query = { 
+                'ResourceID': 'spase://CCMC/Service/InstantRun',
+                'Description': '"Instan-Run"'
+            }</pre>
+
+        Returns
+        -------
+        Dict
+            Dictionary containing a 'Result' key with a value of an
+            ElementTree representation of the results as described by
+            <https://heliophysicsdata.gsfc.nasa.gov/WebServices/hdpspase.xsd>
+            with the addition of the following key/values:<br>
+            - HttpStatus: with the value of the HTTP status code.
+              Successful == 200.<br>
+            When HttpStatus != 200:<br>
+            - HttpText: containing a string representation of the HTTP
+              entity body.<br>
+            When HttpText is a standard HDP WS error entity body the
+            following key/values (convenience to avoid parsing
+            HttpStatus):<br>
+            - ErrorMessage: value from HttpText.<br>
+            - ErrorDescription: value from HttpText.<br>
+        """
+        return self.__get_complex_resource([ResourceType.SERVICE], query)
+
+
+    def get_spase_software(
+            self,
+            query: Dict
+        ) -> Dict:
+        """
+        Gets the specified SPASE Software documents from HDP.
+
+        Parameters
+        ----------
+        query
+            Dictionary containing query parameters and values.  For
+            example,<pre>
+            query = { 
+                'ResourceID': 'spase://CCMC/Software/Kamodo',
+                'CodeLanguage': 'Python',
+                'Description': '"space weather models and data"'
+            }</pre>
+
+        Returns
+        -------
+        Dict
+            Dictionary containing a 'Result' key with a value of an
+            ElementTree representation of the results as described by
+            <https://heliophysicsdata.gsfc.nasa.gov/WebServices/hdpspase.xsd>
+            with the addition of the following key/values:<br>
+            - HttpStatus: with the value of the HTTP status code.
+              Successful == 200.<br>
+            When HttpStatus != 200:<br>
+            - HttpText: containing a string representation of the HTTP
+              entity body.<br>
+            When HttpText is a standard HDP WS error entity body the
+            following key/values (convenience to avoid parsing
+            HttpStatus):<br>
+            - ErrorMessage: value from HttpText.<br>
+            - ErrorDescription: value from HttpText.<br>
+        """
+        return self.__get_complex_resource([ResourceType.SOFTWARE], query)
+
+
     def __get_simple_resource(
             self,
             resource: str,

{hdpws-0.6.18 → hdpws-0.6.22}/hdpws/resourcetype.py

@@ -52,3 +52,4 @@ class ResourceType(Enum):
     DISPLAY_DATA = 'DisplayData'
     OBSERVATORY = 'Observatory'
     SERVICE = 'Service'
+    SOFTWARE = 'Software'

{hdpws-0.6.18 → hdpws-0.6.22}/hdpws.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hdpws
-Version: 0.6.18
+Version: 0.6.22
 Summary: NASA's Heliophysics Data Portal Web Service Client Library
 Home-page: https://heliophysicsdata.gsfc.nasa.gov/WebServices
 Author: Bernie Harris
@@ -44,13 +44,11 @@ To run the included example, do the following
 
 ---
 
-The following [Jupyter notebooks](https://jupyter.org/) demonstrate
+Also, the following [Jupyter notebooks](https://jupyter.org/) demonstrate
 different features of the library:
-1. [Simple Query Example](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExample.html) ([ipynb file](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExample.ipynb))demonstrating a simple query.
-2. [Example with data retrieval](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExampleWithCdasWs.html) using [cdasws](https://pypi.org/project/cdasws/) ([ipynb file](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExampleWithCdasWs.ipynb)).
+1. [Simple Query Example](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExample.html) ([ipynb file](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExample.ipynb)) demonstrating a simple query. [Launch on Binder](https://mybinder.org/v2/gh/berniegsfc/hdpws-notebooks/main?labpath=HdpWsExample.ipynb).
+2. [Example with data retrieval](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExampleWithCdasWs.html) using [cdasws](https://pypi.org/project/cdasws/) ([ipynb file](https://heliophysicsdata.gsfc.nasa.gov/WebServices/jupyter/HdpWsExampleWithCdasWs.ipynb)).  [Launch on Binder](https://mybinder.org/v2/gh/berniegsfc/hdpws-notebooks/main?labpath=HdpWsExampleWithCdasWs.ipynb).
 
-These notebooks will eventually be available on 
-[Binder](https://mybinder.org/v2/gh/berniegsfc/hdpws-notebooks/main).
 
 ## Motivation
 

{hdpws-0.6.18 → hdpws-0.6.22}/setup.py

@@ -10,7 +10,7 @@ README = (HERE / "README.md").read_text()
 # This call to setup() does all the work
 setup(
     name="hdpws",
-    version="0.6.18",
+    version="0.6.22",
     description="NASA's Heliophysics Data Portal Web Service Client Library",
     long_description=README,
     long_description_content_type="text/markdown",

{hdpws-0.6.18 → hdpws-0.6.22}/tests/test_hdpws.py

@@ -24,7 +24,7 @@
 #
 # NOSA HEADER END
 #
-# Copyright (c) 2023 United States Government as represented by
+# Copyright (c) 2023-2024 United States Government as represented by
 # the National Aeronautics and Space Administration. No copyright is
 # claimed in the United States under Title 17, U.S.Code. All Other
 # Rights Reserved.
@@ -60,7 +60,21 @@ class TestHdpWs(unittest.TestCase):
 
     def __init__(self, *args, **kwargs):
         super(TestHdpWs, self).__init__(*args, **kwargs)
-        self._hdp = HdpWs(endpoint='http://localhost:8080/exist/restxq/')
+#        self._hdp = HdpWs(endpoint='http://localhost:8080/exist/restxq/')
+        self._hdp = HdpWs(endpoint='http://localhost:8100/exist/restxq/')
+
+
+    def test_get_application_interfaces(self):
+        """
+        Test for get_application_interfaces function.
+        """
+
+        result = self._hdp.get_application_interfaces()
+
+        self.assertEqual(result['HttpStatus'], 200)
+        application_interfaces = result['ApplicationInterface']
+        self.assertTrue(len(application_interfaces) > 0)
+        self.assertTrue(application_interfaces[0] == 'CLI')
 
 
     def test_get_keywords(self):
@@ -190,10 +204,10 @@ class TestHdpWs(unittest.TestCase):
         result = result['Result']
         result_id_elements = result.findall('.//ResourceID', namespaces=NS)
         result_ids = list(map(lambda e: e.text, result_id_elements))
-        self.assertTrue(len(result_ids) == 3) 
+        # self.assertTrue(len(result_ids) == 3) 
         # above should be == 2 when duplicate is removed from hdp and
         # then the following will work
-        #self.assertTrue(sorted(result_ids) == sorted(resource_ids))
+        self.assertTrue(sorted(result_ids) == sorted(resource_ids))
 
 
     def test_get_spase_if_modified_since(self):
@@ -399,5 +413,48 @@ class TestHdpWs(unittest.TestCase):
         self.assertTrue(result_ids[0] == 'spase://SMWG/Document/HPDE/Policy/HP_DataPolicy_v1.2')
 
 
+    def test_get_spase_service(self):
+        """
+        Test for get_spase_service function.
+        """
+
+        query = {
+            'ResourceID': 'spase://CCMC/Service/InstantRun',
+            'Description': '"Instant-Run"'
+        }  
+
+        result = self._hdp.get_spase_service(query)
+
+        self.assertEqual(result['HttpStatus'], 200)
+        result = result['Result']
+        result_id_elements = result.findall('.//ResourceID',
+                                            namespaces=NS)
+        result_ids = list(map(lambda e: e.text, result_id_elements))
+        self.assertTrue(len(result_ids) == 1)
+        self.assertTrue(result_ids[0] == 'spase://CCMC/Service/InstantRun')
+
+
+    def test_get_spase_software(self):
+        """
+        Test for get_spase_software function.
+        """
+
+        query = {
+            'ResourceID': 'spase://CCMC/Software/Kamodo',
+            'CodeLanguage': 'Python',
+            'Description': '"space weather models and data"'
+        }  
+
+        result = self._hdp.get_spase_software(query)
+
+        self.assertEqual(result['HttpStatus'], 200)
+        result = result['Result']
+        result_id_elements = result.findall('.//ResourceID',
+                                            namespaces=NS)
+        result_ids = list(map(lambda e: e.text, result_id_elements))
+        self.assertTrue(len(result_ids) == 1)
+        self.assertTrue(result_ids[0] == 'spase://CCMC/Software/Kamodo')
+
+
 if __name__ == '__main__':
     unittest.main()