Merge pull request #2766 from ManonMarchand/rename-cds-into-mocserver

rename cds into mocserver

Author: bsipocz

CHANGES.rst

@@ -21,6 +21,11 @@ hsa
 
 - New module to access ESA Herschel mission. [#2122]
 
+mocserver
+^^^^^^^^^
+
+- ``mocserver`` is the new name of the ``cds`` module allowing access to the CDS MOC server [#2766]
+
 esa.hubble
 ^^^^^^^^^^
 
@@ -100,6 +105,12 @@ casda
 - Use the standard ``login`` method for authenticating, which supports the system
   keyring [#2386]
 
+cds
+^^^
+
+the ``cds`` module has been renamed ``mocserver`` and issues a deprecation warning 
+when imported [#2766]
+
 heasarc
 ^^^^^^^
 

astroquery/cds/__init__.py

@@ -18,27 +18,15 @@
   http://www.ivoa.net/documents/MOC/20140602/REC-MOC-1.0-20140602.pdf
 """
 
-from astropy import config as _config
-
-
-class Conf(_config.ConfigNamespace):
-    """
-    Configuration parameters for ``astroquery.template_module``.
-    """
-    server = _config.ConfigItem(
-        ["http://alasky.unistra.fr/MocServer/query",
-         "http://alaskybis.unistra.fr/MocServer/query"],
-        'Name of the template_module server to use.')
-
-    timeout = _config.ConfigItem(
-        30,
-        'Time limit for connecting to template_module server.')
-
+# Licensed under a 3-clause BSD style license - see LICENSE.rst
+import warnings
 
-conf = Conf()
+warnings.warn("The ``cds`` module has been moved to astroquery.mocserver, "
+              "and ``CdsClass`` has been renamed to ``MOCServerClass``. "
+              "Please update your imports.", DeprecationWarning, stacklevel=2)
 
-from .core import cds, CdsClass
+from astroquery.mocserver import MOCServer as cds
+from astroquery.mocserver import MOCServerClass as CdsClass
+from astroquery.mocserver import conf, Conf
 
-__all__ = ['cds', 'CdsClass',
-           'Conf', 'conf',
-           ]
+__all__ = ['conf', 'Conf', 'cds', 'CdsClass']

astroquery/cds/tests/setup_package.py

@@ -0,0 +1,48 @@
+# Licensed under a 3-clause BSD style license - see LICENSE.rst
+"""
+CDS MOCServer Query Tool
+------------------------
+
+:Author: Matthieu Baumann ([email protected])
+
+This package is for querying the CDS MOC service, primarily hosted at:
+
+* http://alasky.unistra.fr/MocServer/query
+* http://alaskybis.unistra.fr/MocServer/query (mirror)
+
+Note: If the access to MOCs with the MOCServer tool was helpful for your research,
+the following acknowledgment would be appreciated::
+
+  This research has made use of the MOCServer, a tool developed at CDS, Strasbourg, France aiming at retrieving
+  MOCs/meta-data from known data-sets. MOC is an IVOA standard described in the following paper :
+  http://www.ivoa.net/documents/MOC/20140602/REC-MOC-1.0-20140602.pdf
+"""
+
+# Licensed under a 3-clause BSD style license - see LICENSE.rst
+
+from astropy import config as _config
+
+
+class Conf(_config.ConfigNamespace):
+    """
+    Configuration parameters for ``astroquery.template_module``.
+    """
+
+    server = _config.ConfigItem(
+        [
+            "http://alasky.unistra.fr/MocServer/query",
+            "http://alaskybis.unistra.fr/MocServer/query",
+        ],
+        "Name of the template_module server to use.",
+    )
+
+    timeout = _config.ConfigItem(
+        30, "Time limit for connecting to template_module server."
+    )
+
+
+conf = Conf()
+
+from .core import MOCServer, MOCServerClass
+
+__all__ = ["Conf", "conf", "MOCServer", "MOCServerClass"]