setup.py

#!/usr/bin/env python
# basic imports
import re
import os
import json
from setuptools import setup, find_packages
import subprocess

RE_GIT_DESC = re.compile(r'v?(.+?)-(\d+)-g(\w+)-?(.+)?')

# Versioning 
# Not actually using Relic (but reimplementing the important part of its functionality)
# means that you cannot downgrade to older versions of Pandokia without manually deleting
# RELIC-INFO
try:
    version = str(subprocess.check_output(["git", "describe", "--tags", "--always", "--abbrev=8", "--dirty"]), encoding="utf-8").strip()
    with open('RELIC-INFO', 'w') as versionfile:
        outdict = {"long": version}
        json.dump(outdict, versionfile)
except (subprocess.CalledProcessError, FileNotFoundError) as err:
    print(err)
    with open("RELIC-INFO") as versionfile:
        version = json.load(versionfile)["long"]

match = RE_GIT_DESC.match(version)
if match is not None:
    shortver, num, commit, dirty_check = match.groups()
    shortver = shortver.split("-")[0]
    version = f"{shortver}"
else:
    version = version.split("-")[0] # just in case -dirty is in the version string

##
#

classifiers = [
    'Development Status :: 5 - Production/Stable',
    'Environment :: Console',
    'Environment :: Web Environment',
    'Intended Audience :: Developers',
    'License :: OSI Approved :: BSD License',
    'Natural Language :: English',
    'Operating System :: POSIX',
    # 'Operating System :: Microsoft :: Windows',
    'Operating System :: MacOS :: MacOS X',
    'Operating System :: Unix',
    'Programming Language :: Python :: 3.6',
    'Programming Language :: Python :: 3.7',
    'Programming Language :: Python :: 3.8',
    'Programming Language :: Python :: 3.9',
    'Programming Language :: Python :: 3.10',
    'Programming Language :: Python :: 3.11',
    'Programming Language :: Python :: 3.12',
    'Topic :: Software Development :: Quality Assurance',
    'Topic :: Software Development :: Testing',
]

# detect our environment
#
# A flag for whether this is a MS Windows machine
#
# n.b. Windows support is strictly experimental and incomplete.

import platform
# print platform.python_version()
windows = platform.system() == 'Windows'

# basic config
#
# This is a list of all the packages that we install.

package_list = [
    'pandokia',                     # core of pandokia system
    'pandokia.runners',             # "plugin-like" things that run various kinds of tests
    'pandokia.helpers',             # modules to use in running your tests
    'stsci_regtest',                # legacy STScI test system for IRAF packages
    'etc_utils',           # utils used by pyetc, pandeia and ssph
    'etc_utils.helpers'    # utils helpers used by pyetc, pandeia and ssph
]

#
# These are all commands that the user can type.
#
python_commands = [
    'pdk',                      # pandokia main entry point
    'pdkrun',                   # like "pdk run"
    'pdk_filecomp',             # helper file comparisons for use in shell scripts
    'pdk_python_runner',        # exec for custom test runner written in python
    'pdk_stsci_regress_helper',  # part of regtest runner
    'pdk_stsci_regress_refs',   # ?
    'pdknose',                  # run nose with pdk plugin
    'pdkpytest',                # run py.test with pdk plugin
    'junittopdk',               # convert junit/xml to pandokia format
    'tbconv',                   # table conversion among various formats
    'pywhere',                  # show where a python module is
    'json_pp',                  # json pretty printer
]

shell_commands = [
    'pdk_gen_contact',          # create contact list for pdk import_contact
    'pdk_monthly',              # cleaner tool for stsci
    'pdk_run_helper.sh',        # helper for shell scripts using "run" runner
    'pdk_shell_runner',         # run a shell script as a test, use exit code as status
    'pdk_shell_runner_helper',  # tools to use in shell_runner scripts
    'pdk_stsci_regress',        # regtest runner
    'sendto',                   # here for convenience; not really pandokia
    'shunit2_plugin_pdk',       # pandokia plugin for shunit2
    'xtname',                   # here for convenience; not really pandokia
    'pdk_sphinxweb',            # builds a bunch of sphinx documents into a web page
    'checktabs',                # check .py/.rst files for tabs in indents
]

command_list = python_commands + shell_commands

##
# we provide setuptools-style entry points that cause plugins to
# be available to some other programs.  This is the setuptools
# format for defining them.

entry_points_dict = {
    'pytest11': ['pandokia = pandokia.helpers.pytest_plugin'],
    'nose.plugins.0.10': ['pandokia = pandokia.helpers.nose_plugin:Pdk']
}

##
# setup args - common to distutils and setuptools

args = {
    'name': 'pandokia',
    'version': '2025.2.dev0',
    'description': 'Pandokia - a test management and reporting system',
    'author': 'Mark Sienkiewicz, Vicki Laidler',
    'author_email': 'help@stsci.edu',
    'url': 'http://ssb.stsci.edu/testing/',
    'license': 'BSD',
    'platforms': [
        'Posix',
        'MacOS X'],
    'scripts': [
        'scripts/' +
        x for x in command_list],
    'packages': package_list,
    'package_data': {
        'pandokia': [
            '*.sql',
            '*.html',
            '*.png',
            '*.gif',
            '*.jpg',
            'sql/*.sql',
            'runners/maker/*']},
    "install_requires": [
        "setuptools"
    ],
    'classifiers': classifiers,
}

# setup args - known by setuptools only

args.update(
    {
        'entry_points': entry_points_dict,
        'zip_safe': False,
    }
)

##
# Actually do the install
#
d = setup(
    **args
)

##
# cgi magic - "python setup.py install --home /a/b/c" and then you can
# "ln -s /a/b/c/bin/pdk ..../pdk.cgi" on your web server.  This setup
# will write this assignment so the cgi can add  /a/b/c/lib/python to
# sys.path at run time.
#
# works with distutils only, not easy_install, pip, or setuptools.
dir_set = "    pdk_dir = r'%s' # this was set during install by setup.py\n"

#
#


def fix_script(name):
    fname = os.path.join(script_dir, name)

    f = open(fname, "r")
    l = f.readlines()
    for count, line in enumerate(l):
        if 'pdk_dir =' in line:
            l[count] = dir_set % lib_dir.replace('\\', '/')
    f.close()

    f = open(fname, "w")
    f.writelines(l)
    f.close()

    # windows versions - we hope to use these everywhere
    # to avoid writing a lot of "if windows: x=x+'.py'"
    f = open(fname + ".py", "w")
    f.writelines(l)
    f.close()

    if windows:
        # make .bat files too, so the commands can have normal names
        f = open(fname + ".bat", "w")
        f.write("@echo off\n%s.py %%*\n" % fname)
        f.close()

    os.chmod(fname + '.py', 0o755)

# py.test and nose use setuptools to find their plugins, but whenever
# I go near setuptools, it always causes problems for me.  You
# can't avoid it with easy_install or pip, but you can otherwise.
#
# If we are just using distutils, procedure here is simple:  Install
# with distutils, then convert the .egg-info file that is installed
# into a setuptools-compatible .egg-info directory that contains the
# entrypoints definition.


def dorque_egg_info(target):
    import os
    # convert entry point dict to a .ini file
    entry_points_file = []
    for x in entry_points_dict:
        entry_points_file.append('[' + x + ']')
        for y in entry_points_dict[x]:
            entry_points_file.append(y)

    entry_points_file = '\n'.join(entry_points_file)

    # read the .egg-info file
    pkginfo = open(target).read()

    # delete it
    os.unlink(target)

    # make the .egg-info a directory
    os.mkdir(target)

    # put files in it
    open(target + "/PKG-INFO", "w").write(pkginfo)
    open(target + "/not-zip-safe", "w").close()
    open(target + "/entry_points.txt", "w").write(entry_points_file)


##
# if the user did an install, do some post-install follow-up

if 'install' in d.command_obj:

    # find where the scripts went
    script_dir = d.command_obj['install'].install_scripts
    lib_dir = d.command_obj['install'].install_lib
    # print 'scripts went to', script_dir
    # print 'python  went to', lib_dir

    # tell the user about the install

    print('')
    print('If you need to change your path for this install:')
    print('')
    print('    set path = ( %s $path )' % script_dir)
    print('    setenv PYTHONPATH  %s:$PYTHONPATH' % lib_dir)
    print('')
    print('    export PATH=%s:$PATH' % script_dir)
    print('    export PYTHONPATH=%s:$PYTHONPATH' % lib_dir)

    print('')
    print('The CGI is:')
    print('')
    print('    %s' % os.path.join(script_dir, 'pdk'))
    print('    If you did not install pandokia in the default location, you must')
    print('    ensure that PYTHONPATH is provided by your web server')
    print('')

    import pandokia
    f = pandokia.cfg.__file__
    if f.endswith(".pyc") or f.endswith(".pyo"):
        f = f[:-1]
    print('The config file is:')
    print('')
    print('    %s' % f)
    print('')
    print('    you can find the config file at any time with the command "pdk config"')
    print('')


else:
    pass
    # print("no install")