casaconfig 0.0.85__tar.gz → 0.0.86__tar.gz

{casaconfig-0.0.85/casaconfig.egg-info → casaconfig-0.0.86}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: casaconfig
-Version: 0.0.85
+Version: 0.0.86
 Summary: CASA Operational Configuration Package
 Home-page: https://github.com/casangi/casaconfig
 Author: National Radio Astronomy Observatory

{casaconfig-0.0.85 → casaconfig-0.0.86}/casaconfig/__main__.py

@@ -97,6 +97,10 @@ try:
             casaconfig.pull_data(measurespath,'release')
             # ignore all other options
         else:
+            # watch for nothing actually set
+            if not flags.updateall and not flags.pulldata and not flags.dataupdate and not flags.measuresupdate:
+                parser.print_help()
+                sys.exit(1)
             # the update options, update all does everything, no need to invoke anything else
             print("Checking for updates into %s" % measurespath)
             if flags.updateall:

{casaconfig-0.0.85 → casaconfig-0.0.86}/casaconfig/private/data_available.py

@@ -29,15 +29,15 @@ def data_available():
     changing casaconfig functions that use those tarballs). The full filename is
     the casarundata version expected in casaconfig functions.
 
-    Parameters:
+    Parameters
        None
     
-    Returns:
-       list: version names returned as list of strings
+    Returns
+       list - version names returned as list of strings
 
-    Raises:
-       casaconfig.RemoteError: Raised when there is an error fetching some remote content
-       Exception: Unexpected exception while getting list of available casarundata versions
+    Raises
+       - casaconfig.RemoteError - Raised when there is an error fetching some remote content
+       - Exception - Unexpected exception while getting list of available casarundata versions
 
     """
 

{casaconfig-0.0.85 → casaconfig-0.0.86}/casaconfig/private/data_update.py

@@ -94,26 +94,26 @@ def data_update(path=None, version=None, force=False, logger=None, auto_update_r
     **Note:** the most recent casarundata may not include the most recent measures data. A data_update
     is typically followed by a measures_update.
 
-    Parameters:
-       path (str=None): Folder path to update. Must contain a valid readme.txt. If not set then config.measurespath is used.
-       version (str=None): Version of casarundata to retrieve (usually in the form of casarundata-x.y.z.tar.gz, see data_available()). Default None retrieves the latest.
-       force (bool=False): If True, always re-download the casarundata. Default False will not download casarundata if updated within the past day unless the version parameter is specified and different from what was last downloaded.
-       logger (casatools.logsink=None): Instance of the casalogger to use for writing messages. Default None writes messages to the terminal.
-       auto_update_rules (bool=False): If True then the user must be the owner of path, version must be None, and force must be False.
-       verbose (int): Level of output, 0 is none, 1 is to logger, 2 is to logger and terminal, defaults to casaconfig_verbose in the config dictionary.
+    Parameters
+       - path (str=None) - Folder path to update. Must contain a valid readme.txt. If not set then config.measurespath is used.
+       - version (str=None) - Version of casarundata to retrieve (usually in the form of casarundata-x.y.z.tar.gz, see data_available()). Default None retrieves the latest.
+       - force (bool=False) - If True, always re-download the casarundata. Default False will not download casarundata if updated within the past day unless the version parameter is specified and different from what was last downloaded.
+       - logger (casatools.logsink=None) - Instance of the casalogger to use for writing messages. Default None writes messages to the terminal.
+       - auto_update_rules (bool=False) - If True then the user must be the owner of path, version must be None, and force must be False.
+       - verbose (int) - Level of output, 0 is none, 1 is to logger, 2 is to logger and terminal, defaults to casaconfig_verbose in the config dictionary.
         
-    Returns:
+    Returns
        None
     
-    Raises:
-       AutoUpdatesNotAllowed : raised when path does not exist as a directory or is not owned by the user
-       BadLock : raised when the lock file was not empty when an attempt was made to obtain the lock
-       BadReadme : raised when the readme.txt file at path did not contain the expected list of installed files or was incorrectly formatted
-       NoReadme : raised when the readme.txt file is not found at path (path also may not exist)
-       NotWritable : raised when the user does not have permission to write to path
-       RemoteError : raised by data_available when the list of available data versions could not be fetched
-       UnsetMeasurespath : raised when path is None and measurespath has not been set in config.
-       Exception: raised when there was an unexpected exception while populating path
+    Raises
+       - casaconfig.AutoUpdatesNotAllowed - raised when path does not exist as a directory or is not owned by the user
+       - casaconfig.BadLock - raised when the lock file was not empty when an attempt was made to obtain the lock
+       - casaconfig.BadReadme - raised when the readme.txt file at path did not contain the expected list of installed files or was incorrectly formatted
+       - casaconfig.NoReadme - raised when the readme.txt file is not found at path (path also may not exist)
+       - casaconfig.NotWritable - raised when the user does not have permission to write to path
+       - casaconfig.RemoteError - raised by data_available when the list of available data versions could not be fetched
+       - casaconfig.UnsetMeasurespath - raised when path is None and measurespath has not been set in config.
+       - Exception - raised when there was an unexpected exception while populating path
 
     """
 

{casaconfig-0.0.85 → casaconfig-0.0.86}/casaconfig/private/do_auto_updates.py

@@ -39,16 +39,16 @@ def do_auto_updates(configDict, logger=None, verbose=None):
 
     See data_update and measures_update for additional details about exceptions
 
-    Paramters:
-       configDict (dict): A config dictionary previously set. 
-       logger (casatools.logsink=None): Instance of the casalogger to use for writing messages. Default None writes messages to the terminal.
-       verbose (int): Level of output, 0 is none, 1 is to logger, 2 is to logger and terminal, defaults to casaconfig_verbose in the config dictionary.
+    Paramters
+       - configDict (dict) - A config dictionary previously set. 
+       - logger (casatools.logsink=None) - Instance of the casalogger to use for writing messages. Default None writes messages to the terminal.
+       - verbose (int) - Level of output, 0 is none, 1 is to logger, 2 is to logger and terminal, defaults to casaconfig_verbose in the config dictionary.
 
-    Returns:
+    Returns
        None
 
-    Raises:
-      UnsetMeasurespath: raised when measurespath is None in config
+    Raises
+       - casaconfig.UnsetMeasurespath - raised when measurespath is None in config
 
     """
 

{casaconfig-0.0.85 → casaconfig-0.0.86}/casaconfig/private/do_pull_data.py

@@ -23,15 +23,15 @@ def do_pull_data(path, version, installed_files, currentVersion, currentDate, lo
     calling function has already examined any existing readme file and used that
     to set the installed_files list as appropriate. 
 
-    Parameters:
-       path (str): Folder path to place casadata contents.
-       version (str): casadata version to retrieve.
-       installed_files (str list): list of installed files from the version already installed. Set to an empty list if there is no previously installed version.
-       currentVersion (str): from the readme file if it already exists, or an empty string if there is no previously installed version.
-       currentDate (str): from the readme file if it already exists, or an empty string if there is no previously installed version.
-       logger (casatools.logsink): Instance of the casalogger to use for writing messages. Messages are always written to the terminal. Set to None to skip writing messages to a logger.
+    Parameters
+       - path (str) - Folder path to place casadata contents.
+       - version (str) - casadata version to retrieve.
+       - installed_files (str list) - list of installed files from the version already installed. Set to an empty list if there is no previously installed version.
+       - currentVersion (str) - from the readme file if it already exists, or an empty string if there is no previously installed version.
+       - currentDate (str) - from the readme file if it already exists, or an empty string if there is no previously installed version.
+       - logger (casatools.logsink) - Instance of the casalogger to use for writing messages. Messages are always written to the terminal. Set to None to skip writing messages to a logger.
 
-    Returns:
+    Returns
        None
 
     """

{casaconfig-0.0.85 → casaconfig-0.0.86}/casaconfig/private/get_config.py

@@ -22,11 +22,11 @@ def get_config( default=False ):
 
     The default values (returned when default is True) are the configuration values after all config files have been evaluated but before the path values have been expanded using os.path.expanduser and os.path.abspath. Modules that use the command line to change config values may also not update the default values. User actions in a CASA session will also typically not change the default values.
 
-    Parameters:
-       default (bool=False): If True, return the default values.
+    Parameters
+       - default (bool=False) - If True, return the default values.
 
-    Returns:
-       list[str]: list of configuration strings
+    Returns
+       - list[str] - list of configuration strings
     """
 
     from .. import config as _config

{casaconfig-0.0.85 → casaconfig-0.0.86}/casaconfig/private/get_data_info.py

@@ -70,17 +70,17 @@ def get_data_info(path=None, logger=None, type=None):
     If path has not been set (has a value of None) then the returned value will be None. This
     likely means that a casasiteconfig.py exists but has not yet been edited to set measurespath.
 
-    Parameters:
-       path (str): Folder path to find the casarundata and measures data information. If not set then config.measurespath is used.
-       logger (casatools.logsink=None): Instance of the casalogger to use for writing messages. Default None writes messages to the terminal.
-       type (str): the specific type of data info to return (None, 'casarundata', 'measures', 'release'; None returns a dictionary of all types)
+    Parameters
+       - path (str) - Folder path to find the casarundata and measures data information. If not set then config.measurespath is used.
+       - logger (casatools.logsink=None) - Instance of the casalogger to use for writing messages. Default None writes messages to the terminal.
+       - type (str) - the specific type of data info to return (None, 'casarundata', 'measures', 'release'; None returns a dictionary of all types)
     
-    Returns:
-       dict: a dictionary by type, 'casarundata', 'measures', 'release' where each type is a dictionary containing 'version' and 'date'. A return value of None indicates path is unset. A value of None for that type means no information could be found about that type. If a specific type is requested then only the dictionary for that type is returned (or None if that type can not be found).
+    Returns
+       - a dictionary by type, 'casarundata', 'measures', 'release' where each type is a dictionary containing 'version' and 'date'. A return value of None indicates path is unset. A value of None for that type means no information could be found about that type. If a specific type is requested then only the dictionary for that type is returned (or None if that type can not be found).
 
-    Raises:
-        UnsetMeasurespath: path is None and has not been set in config
-        ValueError: raised when type has an invalid value
+    Raises
+       - casaconfig.UnsetMeasurespath - path is None and has not been set in config
+       - ValueError - raised when type has an invalid value
 
     """
 

{casaconfig-0.0.85 → casaconfig-0.0.86}/casaconfig/private/get_data_lock.py

@@ -29,16 +29,16 @@ def get_data_lock(path, fn_name):
 
     This function is intended for internal casaconfig use.
 
-    Parameters:
-       path (str): The location where 'data_update.log' is to be found.
-       fn_name (str): A string giving the name of the calling function to be recorded in the lock file.
+    Parameters
+       - path (str) - The location where 'data_update.log' is to be found.
+       - fn_name (str) - A string giving the name of the calling function to be recorded in the lock file.
 
     Returns:
-       fd: the open file descriptor holding the lock. Close this file descriptor to release the lock.
+       - the open file descriptor holding the lock. Close this file descriptor to release the lock.
 
     Raises:
-        BadLock: raised when the path to the lock file does not exist or the lock file is not empty as found
-        Exception: an unexpected exception was seen while writing the lock information to the file
+        - casaconfig.BadLock - raised when the path to the lock file does not exist or the lock file is not empty as found
+        - Exception - an unexpected exception was seen while writing the lock information to the file
 
     """
 

{casaconfig-0.0.85 → casaconfig-0.0.86}/casaconfig/private/measures_available.py

@@ -25,15 +25,15 @@ def measures_available():
     of the values in that list if set (otherwise the most recent version
     in this list is used).
 
-    Parameters:
+    Parameters
        None
     
-    Returns:
-       list: version names returned as list of strings
+    Returns
+       version names returned as list of strings
 
     Raises:
-       RemoteError: raised when when a socket.gaierror is seen, likely due to no network connection
-       Exception: raised when any unexpected exception happens
+       - casaconfig.RemoteError - raised when when a socket.gaierror is seen, likely due to no network connection
+       - Exception: raised when any unexpected exception happens
 
     """
     from ftplib import FTP

{casaconfig-0.0.85 → casaconfig-0.0.86}/casaconfig/private/measures_update.py

@@ -102,26 +102,26 @@ def measures_update(path=None, version=None, force=False, logger=None, auto_upda
     is not empty or the readme.txt file can not be read. This use of force should be used
     with caution.
 
-    Parameters:
-       path (str=None): Folder path to place updated measures data. Must contain a valid geodetic/readme.txt. If not set then config.measurespath is used.
-       version (str=None): Version of measures data to retrieve (usually in the form of yyyymmdd-160001.ztar, see measures_available()). Default None retrieves the latest.
-       force (bool=False): If True, always re-download the measures data. Default False will not download measures data if updated within the past day unless the version parameter is specified and different from what was last downloaded.
-       logger (casatools.logsink=None): Instance of the casalogger to use for writing messages. Default None writes messages to the terminal
-       auto_update_rules (bool=False): If True then the user must be the owner of path, version must be None, and force must be False.
-       verbose (int=None): Level of output, 0 is none, 1 is to logger, 2 is to logger and terminal, defaults to casaconfig_verbose in config dictionary.
+    Parameters
+       - path (str=None) - Folder path to place updated measures data. Must contain a valid geodetic/readme.txt. If not set then config.measurespath is used.
+       - version (str=None) - Version of measures data to retrieve (usually in the form of yyyymmdd-160001.ztar, see measures_available()). Default None retrieves the latest.
+       - force (bool=False) - If True, always re-download the measures data. Default False will not download measures data if updated within the past day unless the version parameter is specified and different from what was last downloaded.
+       - logger (casatools.logsink=None) - Instance of the casalogger to use for writing messages. Default None writes messages to the terminal
+       - auto_update_rules (bool=False) - If True then the user must be the owner of path, version must be None, and force must be False.
+       - verbose (int=None) - Level of output, 0 is none, 1 is to logger, 2 is to logger and terminal, defaults to casaconfig_verbose in config dictionary.
         
-    Returns:
+    Returns
        None
 
-    Raises:
-       AutoUpdatesNotAllowed: raised when path does not exists as a directory or is not owned by the user when auto_update_rules is True
-       BadLock: raised when the lock file was not empty when found
-       BadReadme: raised when something unexpected is found in the readme or the readme changed after an update is in progress
-       NoReadme : raised when the readme.txt file is not found at path (path also may not exist)
-       NotWritable: raised when the user does not have permission to write to path
-       RemoteError: raised by measures_available when the remote list of measures could not be fetched
-       UnsetMeasurespath: raised when path is None and has not been set in config
-       Exception: raised when something unexpected happened while updating measures
+    Raises
+       casaconfig.AutoUpdatesNotAllowed - raised when path does not exists as a directory or is not owned by the user when auto_update_rules is True
+       casaconfig.BadLock - raised when the lock file was not empty when found
+       casaconfig.BadReadme - raised when something unexpected is found in the readme or the readme changed after an update is in progress
+       casaconfig.NoReadme - raised when the readme.txt file is not found at path (path also may not exist)
+       casaconfig.NotWritable - raised when the user does not have permission to write to path
+       casaconfig.RemoteError - raised by measures_available when the remote list of measures could not be fetched
+       casaconfig.UnsetMeasurespath - raised when path is None and has not been set in config
+       Exception - raised when something unexpected happened while updating measures
     
     """
     import os

{casaconfig-0.0.85 → casaconfig-0.0.86}/casaconfig/private/print_log_messages.py

@@ -27,10 +27,10 @@ def print_log_messages(msg, logger, is_err=False, verbose=2):
     This function is intended for internal casaconfig use.
 
     Parameters
-       msg (str): The message to print and optionally log.
-       logger (casatools.logsink): Instance of the casalogger to use. Not used if None.
-       is_err (bool=False): When False, output goes to sys.stdout and logged as INFO level. When True, output goes to sys.stderr and logged as SEVERE
-       verbose (int=2): When < 2 then msg is only printed if there is no logger, otherwise it's just logged
+       - msg (str) - The message to print and optionally log.
+       - logger (casatools.logsink) - Instance of the casalogger to use. Not used if None.
+       - is_err (bool=False) - When False, output goes to sys.stdout and logged as INFO level. When True, output goes to sys.stderr and logged as SEVERE
+       - verbose (int=2) - When < 2 then msg is only printed if there is no logger, otherwise it's just logged
 
     Returns
        None

{casaconfig-0.0.85 → casaconfig-0.0.86}/casaconfig/private/pull_data.py

@@ -83,22 +83,22 @@ def pull_data(path=None, version=None, force=False, logger=None, verbose=None):
     what versions are available. There is no check on when the data were last updated before
     calling data_available (as there is in the two update functions). 
 
-    Parameters:
-       path (str): Folder path to place casarundata contents. It must be empty or not exist or contain a valid, previously installed version. If not set then config.measurespath is used.
-       version (str=None): casadata version to retrieve. Default None gets the most recent version.
-       force (bool=False): If True, re-download and install the data even when the requested version matches what is already installed. Default False will not download data if the installed version matches the requested version.
-       logger (casatools.logsink=None): Instance of the casalogger to use for writing messages. Messages are always written to the terminal. Default None does not write any messages to a logger.
-       verbose (int): Level of output, 0 is none, 1 is to logger, 2 is to logger and terminal, defaults to casaconfig_verbose in the config dictionary.
-
-    Returns:
+    Parameters
+       - path (str) - Folder path to place casarundata contents. It must be empty or not exist or contain a valid, previously installed version. If not set then config.measurespath is used.
+       - version (str=None) - casadata version to retrieve. Default None gets the most recent version.
+       - force (bool=False) - If True, re-download and install the data even when the requested version matches what is already installed. Default False will not download data if the installed version matches the requested version.
+       - logger (casatools.logsink=None) - Instance of the casalogger to use for writing messages. Messages are always written to the terminal. Default None does not write any messages to a logger.
+       - verbose (int) - Level of output, 0 is none, 1 is to logger, 2 is to logger and terminal, defaults to casaconfig_verbose in the config dictionary.
+
+    Returns
        None
 
-    Raises:
-       BadLock: raised when the lock file is not empty when a lock is requested
-       BadReadme: raised when the readme.txt file found at path does not contain the expected list of installed files or there was an unexpected change while the data lock is on
-       NotWritable: raised when the user does not have write permission to path
-       RemoteError : raised by data_available when the list of available data versions could not be fetched
-       UnsetMeasurespath: raised when path is None and and measurespath has not been set in config.
+    Raises
+       - casaconfig.BadLock - raised when the lock file is not empty when a lock is requested
+       - casaconfig.BadReadme - raised when the readme.txt file found at path does not contain the expected list of installed files or there was an unexpected change while the data lock is on
+       - casaconfig.NotWritable - raised when the user does not have write permission to path
+       - casaconfig.RemoteError - raised by data_available when the list of available data versions could not be fetched
+       - casaconfig.UnsetMeasurespath - raised when path is None and and measurespath has not been set in config.
 
     """
 

{casaconfig-0.0.85 → casaconfig-0.0.86}/casaconfig/private/read_readme.py

@@ -29,11 +29,11 @@ def read_readme(path):
 
     The version string and date are stripped of leading and trailing whitespace.
 
-    Parameters:
-       path (str): the path to the file to be read
+    Parameters
+       - path (str) - the path to the file to be read
 
-    Returns:
-       dict: Dictionary of 'version' (the version string), 'date' (the date string),
+    Returns
+       Dictionary of 'version' (the version string), 'date' (the date string),
              'extra' (a list of any extra lines found). The return value is None on error.
     """
 

{casaconfig-0.0.85 → casaconfig-0.0.86}/casaconfig/private/set_casacore_path.py

@@ -25,10 +25,10 @@ def set_casacore_path(path=None):
     the casacore data directory can be found by casacore users. It sets the value of that
     parameter to the casacore data location, replacing any previously set value.
 
-    Parameters:
-       path (string=None): path to the desired data directory. Default None uses the included data directory from this package
+    Parameters
+       - path (string=None) - path to the desired data directory. Default None uses the included data directory from this package
 
-    Returns:
+    Returns
        None
 
     """

{casaconfig-0.0.85 → casaconfig-0.0.86}/casaconfig/private/summary.py

@@ -22,10 +22,10 @@ def summary(configDict = None):
     value of the measurespath config value is shown, the installed data versions are shown
     (casarundata and measures) and any release version information is shown.
 
-    Parameters:
-        configDict (dict): a config dictionary. If None this is imported from casaconfig.
+    Parameters
+        - configDict (dict) - a config dictionary. If None this is imported from casaconfig.
 
-    Returns:
+    Returns
         None
 
     """

{casaconfig-0.0.85 → casaconfig-0.0.86}/casaconfig/private/update_all.py

@@ -47,12 +47,12 @@ def update_all(path=None, logger=None, force=False, verbose=None):
     Use of update_all after CASA has started should typically be followed by a restart 
     so that any changes are seen by the tools and tasks that use this data.
 
-    Parameters:
-       path (str=None): Folder path to place casarundata contents. It must not exist, or be empty, or contain a valid, previously installed version. If it exists, it must be owned by the user. Default None uses the value of measurespath set by importing config.py.
-       logger (casatools.logsink=None): Instance of the casalogger to use for writing messages. Messages are always written to the terminal. Default None does not write any messages to a logger.
-       verbose (int): Level of output, 0 is none, 1 is to logger, 2 is to logger and terminal, defaults to casaconfig_verbose in the config dictionary.
+    Parameters
+       - path (str=None) - Folder path to place casarundata contents. It must not exist, or be empty, or contain a valid, previously installed version. If it exists, it must be owned by the user. Default None uses the value of measurespath set by importing config.py.
+       - logger (casatools.logsink=None) - Instance of the casalogger to use for writing messages. Messages are always written to the terminal. Default None does not write any messages to a logger.
+       - verbose (int) - Level of output, 0 is none, 1 is to logger, 2 is to logger and terminal, defaults to casaconfig_verbose in the config dictionary.
 
-    Returns:
+    Returns
        None
 
     """

{casaconfig-0.0.85 → casaconfig-0.0.86/casaconfig.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: casaconfig
-Version: 0.0.85
+Version: 0.0.86
 Summary: CASA Operational Configuration Package
 Home-page: https://github.com/casangi/casaconfig
 Author: National Radio Astronomy Observatory

{casaconfig-0.0.85 → casaconfig-0.0.86}/setup.py

@@ -6,7 +6,7 @@ with open('README.md', "r") as fid:   #encoding='utf-8'
 
 setup(
     name='casaconfig',
-    version='0.0.85',
+    version='0.0.86',
     description='CASA Operational Configuration Package',
     long_description=long_description,
     long_description_content_type="text/markdown",