cdasws 1.8.12__tar.gz → 1.8.13__tar.gz

{cdasws-1.8.12 → cdasws-1.8.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cdasws
-Version: 1.8.12
+Version: 1.8.13
 Summary: NASA's Coordinated Data Analysis System Web Service Client Library
 Home-page: https://cdaweb.gsfc.nasa.gov/WebServices/REST
 Author: Bernie Harris
@@ -16,6 +16,7 @@ Classifier: Intended Audience :: System Administrators
 Classifier: License :: OSI Approved :: NASA Open Source Agreement v1.3 (NASA-1.3)
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Scientific/Engineering :: Physics
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Description-Content-Type: text/markdown

{cdasws-1.8.12 → cdasws-1.8.13}/cdasws/__init__.py

@@ -24,7 +24,7 @@
 #
 # NOSA HEADER END
 #
-# Copyright (c) 2018-2025 United States Government as represented by
+# Copyright (c) 2018-2026 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.
@@ -35,7 +35,7 @@
 Package for accessing the Coordinate Data Analysis System (CDAS)
 web services <https://cdaweb.gsfc.nasa.gov/WebServices/REST/>.<br>
 
-Copyright &copy; 2018-2025 United States Government as represented by the
+Copyright &copy; 2018-2026 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.
 
@@ -55,7 +55,7 @@ Notes
 """
 
 
-__version__ = "1.8.12"
+__version__ = "1.8.13"
 
 
 #
@@ -82,4 +82,4 @@ NAMESPACES = {
 #
 # For backward compatibility with cdasws versions < 1.8.12.
 #
-from cdasws.cdasws import *
+from cdasws.cdasws import *  # pylint: disable=wrong-import-position

{cdasws-1.8.12 → cdasws-1.8.13}/cdasws/__main__.py

@@ -24,7 +24,7 @@
 #
 # NOSA HEADER END
 #
-# Copyright (c) 2018-2025 United States Government as represented by
+# Copyright (c) 2018-2026 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,7 +34,7 @@
 Example Coordinate Data Analysis System (CDAS) web service client.
 Includes example calls to most of the web services.
 
-Copyright © 2018-2025 United States Government as represented by the
+Copyright © 2018-2026 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.
 """
@@ -52,6 +52,7 @@ from cdasws.cdasws import CdasWs
 from cdasws.timeinterval import TimeInterval
 from cdasws.datarequest import GraphOptions, ImageFormat, Overplot, TextFormat
 from cdasws.datarepresentation import DataRepresentation
+from cdasws.doi import get_doi_landing_page_url
 
 
 logging.basicConfig()
@@ -147,7 +148,7 @@ def example(
 
     cdas = CdasWs(endpoint=endpoint, ca_certs=ca_certs,
                   disable_ssl_certificate_validation=
-                  disable_ssl_certificate_validation, 
+                  disable_ssl_certificate_validation,
                   disable_cache = disable_cache, user_agent='Example')
 
     print(cdas.get_observatory_groups(
@@ -166,7 +167,7 @@ def example(
         #print('  ', json.dumps(dataset, indent=4))
 
     print('DOI landing page:',
-          cdas.get_doi_landing_page_url('10.48322/e0dc-0h53'))
+          get_doi_landing_page_url('10.48322/e0dc-0h53'))
 
     print('citation = ' + cdas.get_citation('10.48322/541v-1f57'))
 

{cdasws-1.8.12 → cdasws-1.8.13}/cdasws/cdasws.py

@@ -24,7 +24,7 @@
 #
 # NOSA HEADER END
 #
-# Copyright (c) 2018-2025 United States Government as represented by
+# Copyright (c) 2018-2026 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.
@@ -35,7 +35,7 @@
 Module for accessing the Coordinate Data Analysis System (CDAS)
 web services <https://cdaweb.gsfc.nasa.gov/WebServices/REST/>.<br>
 
-Copyright &copy; 2018-2025 United States Government as represented by the
+Copyright &copy; 2018-2026 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,19 +60,19 @@ import os
 import platform
 import logging
 import re
-from importlib.util import find_spec
+#from importlib.util import find_spec
 import urllib.parse
 from urllib.parse import urlparse
-import json
+#import json
 from operator import itemgetter
 import time
-from datetime import datetime, timedelta, timezone
+from datetime import datetime, timedelta
 import xml.etree.ElementTree as ET
 from tempfile import mkstemp
 from typing import Any, Callable, Dict, List, Tuple, Union
 
 import requests
-import dateutil.parser
+#import dateutil.parser
 
 from cdasws.datarepresentation import DataRepresentation
 from cdasws.datarequest import AudioRequest, DataRequest
@@ -80,6 +80,8 @@ from cdasws.datarequest import CdfFormat, CdfRequest, Compression
 from cdasws.datarequest import ImageFormat, GraphOptions, GraphRequest
 from cdasws.datarequest import TextFormat, TextRequest, ThumbnailRequest
 from cdasws.timeinterval import TimeInterval
+from cdasws.doi import get_doi_landing_page_url
+from cdasws import __version__, RETRY_LIMIT, NAMESPACES as NS
 
 
 # requires python >= 3.4
@@ -143,8 +145,6 @@ try:
 except ImportError:
     CACHE_AVAILABLE = False
 
-from cdasws import __version__, RETRY_LIMIT, NAMESPACES as NS
-
 
 def _get_data_progress(
         progress: float,
@@ -919,6 +919,9 @@ class CdasWs:
         Returns a URL to the given Digital Object Identifier's landing
         page (metadata for the DOI).
 
+        Note: this method is deprecated.  You should call 
+        doi.get_doi_landing_page_url directly.
+
         Parameters
         ----------
         doi
@@ -929,9 +932,7 @@ class CdasWs:
             A URL to the DOI's landing page.
         """
 
-        if not doi.startswith('http'):
-            return 'https://doi.org/' + doi
-        return doi
+        return get_doi_landing_page_url(doi)
 
 
     @staticmethod

{cdasws-1.8.12 → cdasws-1.8.13}/cdasws/datarequest.py

@@ -24,7 +24,7 @@
 #
 # NOSA HEADER END
 #
-# Copyright (c) 2019-2024 United States Government as represented by
+# Copyright (c) 2019-2026 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.
@@ -36,7 +36,7 @@ Package defining classes to represent the DataRequestEntity and its
 sub-classes from
 <https://cdaweb.gsfc.nasa.gov/WebServices/REST/CDAS.xsd>.<br>
 
-Copyright &copy; 2019-2024 United States Government as represented by the
+Copyright &copy; 2019-2026 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.
 """
@@ -350,7 +350,6 @@ class DataRequest(metaclass=ABCMeta): # pylint: disable=too-few-public-methods
             string XML representation of this object.
         """
 
-        #return ET.tostring(self.xml_element(), encoding="utf-8", method='xml', xml_declaration=True)
         return ET.tostring(self.xml_element(), encoding="utf-8", method='xml')
 
 

cdasws-1.8.13/cdasws/doi.py

@@ -0,0 +1,127 @@
+#!/usr/bin/env python3
+
+#
+# NOSA HEADER START
+#
+# The contents of this file are subject to the terms of the NASA Open
+# Source Agreement (NOSA), Version 1.3 only (the "Agreement").  You may
+# not use this file except in compliance with the Agreement.
+#
+# You can obtain a copy of the agreement at
+#   docs/NASA_Open_Source_Agreement_1.3.txt
+# or
+#   https://cdaweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt.
+#
+# See the Agreement for the specific language governing permissions
+# and limitations under the Agreement.
+#
+# When distributing Covered Code, include this NOSA HEADER in each
+# file and include the Agreement file at
+# docs/NASA_Open_Source_Agreement_1.3.txt.  If applicable, add the
+# following below this NOSA HEADER, with the fields enclosed by
+# brackets "[]" replaced with your own identifying information:
+# Portions Copyright [yyyy] [name of copyright owner]
+#
+# NOSA HEADER END
+#
+# Copyright (c) 2025 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.
+#
+
+
+"""
+Module defines utility functions related to Digital Object Identifiers
+(DOI).<br>
+
+Copyright &copy; 2025 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.
+"""
+
+
+def get_canonical_doi(
+        doi: str
+    ) -> str:
+    """
+    Returns a canonical representation (no leading https://doi.org/ and 
+    lower case) Digital Object Identifier (DOI) value.
+
+    Parameters
+    ----------
+    doi
+        digital object identifier.
+    Returns
+    -------
+    str
+        The canonical DOI value.
+    """
+    return doi.replace('https://doi.org/', '').lower()
+
+
+def get_doi_landing_page_url(
+        doi: str
+    ) -> str:
+    """
+    Returns a URL to the given Digital Object Identifier's landing
+    page (metadata for the DOI).
+
+    Parameters
+    ----------
+    doi
+        digital object identifier.
+    Returns
+    -------
+    str
+        A URL to the DOI's landing page.
+    """
+
+    if not doi.startswith('http'):
+        return 'https://doi.org/' + doi
+    return doi
+
+
+def get_doi_badge_url(
+        doi: str
+    ) -> str:
+    """
+    Returns a URL to the given Digital Object Identifier's badge.
+
+    Parameters
+    ----------
+    doi
+        digital object identifier.
+    Returns
+    -------
+    str
+        A URL to the DOI's badge.
+    """
+
+    canonical_doi = get_canonical_doi(doi)
+
+    return 'https://img.shields.io/badge/DOI-' + \
+           canonical_doi.replace('-', '--') + '-blue'
+
+
+def get_doi_hdp_url(
+        doi: str
+    ) -> str:
+    """
+    Returns a URL to the given Digital Object Identifier's Heliophysics
+    Data Portal (HDP) page.
+
+    Parameters
+    ----------
+    doi
+        digital object identifier.
+    Returns
+    -------
+    str
+        A URL to the DOI's HDP page.
+    """
+
+    canonical_doi = get_canonical_doi(doi)
+
+    return 'https://heliophysicsdata.gsfc.nasa.gov/WS/hdp/1/Spase/' \
+           'NumericalData;DisplayData?DOI=' + canonical_doi

{cdasws-1.8.12 → cdasws-1.8.13}/cdasws.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cdasws
-Version: 1.8.12
+Version: 1.8.13
 Summary: NASA's Coordinated Data Analysis System Web Service Client Library
 Home-page: https://cdaweb.gsfc.nasa.gov/WebServices/REST
 Author: Bernie Harris
@@ -16,6 +16,7 @@ Classifier: Intended Audience :: System Administrators
 Classifier: License :: OSI Approved :: NASA Open Source Agreement v1.3 (NASA-1.3)
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Scientific/Engineering :: Physics
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Description-Content-Type: text/markdown

{cdasws-1.8.12 → cdasws-1.8.13}/cdasws.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ cdasws/__main__.py
 cdasws/cdasws.py
 cdasws/datarepresentation.py
 cdasws/datarequest.py
+cdasws/doi.py
 cdasws/timeinterval.py
 cdasws.egg-info/PKG-INFO
 cdasws.egg-info/SOURCES.txt
@@ -14,4 +15,5 @@ cdasws.egg-info/requires.txt
 cdasws.egg-info/top_level.txt
 tests/test_cdasws.py
 tests/test_datarequest.py
+tests/test_doi.py
 tests/test_timeinterval.py

{cdasws-1.8.12 → cdasws-1.8.13}/setup.py

@@ -10,7 +10,7 @@ README = (HERE / "README.md").read_text()
 # This call to setup() does all the work
 setup(
     name="cdasws",
-    version="1.8.12",
+    version="1.8.13",
     description="NASA's Coordinated Data Analysis System Web Service Client Library",
     long_description=README,
     long_description_content_type="text/markdown",
@@ -40,6 +40,7 @@ setup(
         "License :: OSI Approved :: NASA Open Source Agreement v1.3 (NASA-1.3)",
         "Operating System :: OS Independent",
         "Programming Language :: Python",
+        "Programming Language :: Python :: 3",
         "Topic :: Scientific/Engineering :: Physics",
         "Topic :: Software Development :: Libraries :: Python Modules"
     ],

{cdasws-1.8.12 → cdasws-1.8.13}/tests/test_cdasws.py

@@ -24,7 +24,7 @@
 #
 # NOSA HEADER END
 #
-# Copyright (c) 2019-2025 United States Government as represented by
+# Copyright (c) 2019-2026 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.
@@ -33,7 +33,7 @@
 """
 Module for unittest of the CdasWs class.<br>
 
-Copyright &copy; 2019-2025 United States Government as represented by the
+Copyright &copy; 2019-2026 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.
 """
@@ -1406,7 +1406,7 @@ class TestCdasWs(unittest.TestCase):
         doi = '10.48322/541v-1f57'
         result = \
             self._cdas.get_citation(doi)
-        self.assertEqual(result, 'Nakamura, R., Torkar, K. M., Jeszenszky, H., &amp; Burch, J. L. (2022). <i>MMS 1 Active Spacecraft Potential Control (ASPOC), Sensors 1 and 2, Level 2 (L2), Survey Mode, 1 s Data</i> [Data set]. NASA Space Physics Data Facility. https://doi.org/10.48322/541V-1F57')
+        self.assertEqual(result, 'Nakamura, R., Torkar, K. M., Jeszenszky, H., &amp; Burch, J. L. (2022). <i>MMS 1 Active Spacecraft Potential Control (ASPOC), Sensors 1 and 2, Level 2 (L2), Survey Mode, 1 s Data</i> [Data set]. Laboratory for Atmospheric and Space Physics; Space Physics Data Facility. https://doi.org/10.48322/541V-1F57')
 
 
 if __name__ == '__main__':

cdasws-1.8.13/tests/test_doi.py

@@ -0,0 +1,94 @@
+#!/usr/bin/env python3
+
+#
+# NOSA HEADER START
+#
+# The contents of this file are subject to the terms of the NASA Open
+# Source Agreement (NOSA), Version 1.3 only (the "Agreement").  You may
+# not use this file except in compliance with the Agreement.
+#
+# You can obtain a copy of the agreement at
+#   docs/NASA_Open_Source_Agreement_1.3.txt
+# or
+#   https://cdaweb.gsfc.nasa.gov/WebServices/NASA_Open_Source_Agreement_1.3.txt.
+#
+# See the Agreement for the specific language governing permissions
+# and limitations under the Agreement.
+#
+# When distributing Covered Code, include this NOSA HEADER in each
+# file and include the Agreement file at
+# docs/NASA_Open_Source_Agreement_1.3.txt.  If applicable, add the
+# following below this NOSA HEADER, with the fields enclosed by
+# brackets "[]" replaced with your own identifying information:
+# Portions Copyright [yyyy] [name of copyright owner]
+#
+# NOSA HEADER END
+#
+# Copyright (c) 2025 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.
+#
+
+"""
+Module for unittest of the doi functions.<br>
+
+Copyright &copy; 2025 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.
+"""
+
+import unittest
+from cdasws.doi import *
+
+#from context import cdasws  # pylint: disable=unused-import
+
+
+
+class TestTimeInterval(unittest.TestCase):
+    """
+    Class for unittest of doi module functions.
+    """
+
+    def __init__(self, *args, **kwargs):
+        super(TestTimeInterval, self).__init__(*args, **kwargs)
+
+
+    def test_get_canonical_doi(self):
+        """
+        Test for get_canonical_doi function.
+        """
+
+        self.assertEqual(get_canonical_doi('https://doi.org/ABC/123'), 'abc/123')
+        self.assertEqual(get_canonical_doi('XYZ/321'), 'xyz/321')
+
+
+    def test_get_doi_landing_page_url(self):
+        """
+        Test for get_doi_landing_page_url function.
+        """
+
+        self.assertEqual(get_doi_landing_page_url('https://doi.org/ABC/123'), 'https://doi.org/ABC/123')
+        self.assertEqual(get_doi_landing_page_url('ABC/123'), 'https://doi.org/ABC/123')
+
+
+    def test_get_doi_badge_url(self):
+        """
+        Test for get_doi_badge_url function.
+        """
+
+        self.assertEqual(get_doi_badge_url('https://doi.org/ABC/123'), 'https://img.shields.io/badge/DOI-abc/123-blue')
+        self.assertEqual(get_doi_badge_url('XYZ/321'), 'https://img.shields.io/badge/DOI-xyz/321-blue')
+        self.assertEqual(get_doi_badge_url('XYZ/123-321'), 'https://img.shields.io/badge/DOI-xyz/123--321-blue')
+
+
+    def test_get_doi_hdp_url(self):
+        """
+        Test for get_doi_hdp_url function.
+        """
+
+        self.assertEqual(get_doi_hdp_url('https://doi.org/ABC/123'), 'https://heliophysicsdata.gsfc.nasa.gov/WS/hdp/1/Spase/NumericalData;DisplayData?DOI=abc/123')
+
+
+if __name__ == '__main__':
+    unittest.main()