check_env.py

#!/usr/bin/env python
"""
Check for required dependencies for the workshop.
Usage::

  % python check_env.py

"""
from packaging.version import Version

# NOTE: Update minversion values as needed.
# This should match environment.yml and requirements.txt contents.
PKGS = {'IPython': '8.0',
        'cython': None,
        'jupyter': None,
        'notebook': '7.0',
        'numpy': '1.26',
        'scipy': '1.11',
        'skimage': '0.22',
        'matplotlib': '3.8',
        'pandas': '2.1',
        'bs4': None,  # beautifulsoup4
        'keyring': None,
        'html5lib': None,
        'xlwt': None,
        'xlrd': None,
        'requests': None,
        'jupyterlab': None,
        'nbgitpuller': None,
        'astropy': '6.0',
        'asdf': None,
        'gwcs': '0.20',
        'ccdproc': '2.4',
        'photutils': '1.10.0',
        'specutils': '1.12.0',
        'astroquery': '0.4.7dev9008',
        'openpyxl': None}


def check_package(package_name, minimum_version=None, verbose=True):
    errors = False
    try:
        pkg = __import__(package_name)
    except ImportError as err:
        print(f'Error: Failed import: {err}')
        errors = True
    else:
        if package_name in ('jupyter', 'keyring'):
            installed_version = ''
        elif package_name == 'xlwt':
            installed_version = pkg.__VERSION__
        else:
            installed_version = pkg.__version__
        if (minimum_version is not None and
                Version(installed_version) <
                Version(str(minimum_version))):
            print(f'Error: {package_name} version {minimum_version} or '
                  f'later is required, you have version {installed_version}')
            errors = True
        if not errors and verbose:
            print('Found', package_name, installed_version)
    return errors


def run_checks():
    errors = []
    for package_name, min_version in PKGS.items():
        errors.append(check_package(package_name, minimum_version=min_version))
    if any(errors):
        print('\nThere are errors that you must resolve before running the '
              'tutorials.')
    else:
        print('\nYour Python environment is good to go!')


if __name__ == '__main__':
    run_checks()