hdpws 0.6.18__py3-none-any.whl → 0.6.22__py3-none-any.whl

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/__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/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/resourcetype.py

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

{hdpws-0.6.18.dist-info → hdpws-0.6.22.dist-info}/METADATA

@@ -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
@@ -47,13 +47,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.22.dist-info/RECORD

@@ -0,0 +1,11 @@
+hdpws/__init__.py,sha256=N9oVbW1qhgeECE9f7QWqy2vV-1G0a8lgppXiwht-0C8,2059
+hdpws/__main__.py,sha256=vumYLbz12sIRum3o6BNDw0XOzGrYMOvNCM2cufHBpb4,15241
+hdpws/dateinterval.py,sha256=OwFRQUbTMyzR1R7T5gSKT2st4PbLWAwOtcsP7_PqQys,4901
+hdpws/hdpws.py,sha256=EYnnCo2JtkP5GjpykxF6VGz1NmGFTVTuh3g4yjCAmqQ,40168
+hdpws/resourcetype.py,sha256=ybBKFKDcVesRkRKb-mEXIxRt-INed3QZzysx1rmy6bo,1771
+hdpws/spase.py,sha256=ylnH9mh1McwwyB6-LzaOOWr1ggJiuNgcEH3-6mXJjfI,13343
+hdpws-0.6.22.dist-info/LICENSE,sha256=9VDxMcDDn3_T-sDQTMPxmiPZBDkPIiTO4OzYK5olDmk,12589
+hdpws-0.6.22.dist-info/METADATA,sha256=GGmJKY62xmIhNrllEjFQTWlJxS9G0Jp6al2jmH_i-lM,3656
+hdpws-0.6.22.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+hdpws-0.6.22.dist-info/top_level.txt,sha256=BTo-2sxU1YuKAD5Ykfc8bNQvgVX486A74voiQxV4NiQ,6
+hdpws-0.6.22.dist-info/RECORD,,

hdpws-0.6.18.dist-info/RECORD

@@ -1,11 +0,0 @@
-hdpws/__init__.py,sha256=g8DxcAZIN8aJO6XHL0Pu2b1B3NOy14p5DVRjVVtpBuM,2049
-hdpws/__main__.py,sha256=PgHfzwwUy56Rk-kHm7SDkoUGC4oN7z0DUJ1KhsVvI4g,14181
-hdpws/dateinterval.py,sha256=OwFRQUbTMyzR1R7T5gSKT2st4PbLWAwOtcsP7_PqQys,4901
-hdpws/hdpws.py,sha256=an9VJdBBzI73DC1QmRcOVmXdx6rN1ZUZiqAgCtLHFTg,36157
-hdpws/resourcetype.py,sha256=V3ge09mdFfN7tOl6txk9nF_dPr04L7ReoV7WoL0IneE,1745
-hdpws/spase.py,sha256=ylnH9mh1McwwyB6-LzaOOWr1ggJiuNgcEH3-6mXJjfI,13343
-hdpws-0.6.18.dist-info/LICENSE,sha256=9VDxMcDDn3_T-sDQTMPxmiPZBDkPIiTO4OzYK5olDmk,12589
-hdpws-0.6.18.dist-info/METADATA,sha256=fcQRmzMB1_ElroYo_omfKEj73bynblnCji3PdxK_sTI,3543
-hdpws-0.6.18.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-hdpws-0.6.18.dist-info/top_level.txt,sha256=BTo-2sxU1YuKAD5Ykfc8bNQvgVX486A74voiQxV4NiQ,6
-hdpws-0.6.18.dist-info/RECORD,,