setup.py

#!/usr/bin/env python
from __future__ import print_function
import os
import re
import setuptools


PYTHON_SRC = 'python'
PYTHON_FILE_RE = re.compile('.*\.(?:py[co]?)$')


# TODO: Auto-append dev version based on how forward from latest release
#       Basically a simpler version of what setuptools_scm does but without
#       the added cruft and bringing the ENTIRE git repo in with the dist
#       See: https://github.com/pypa/setuptools_scm/blob/master/setuptools_scm/version.py
#       Would need to know number of commits ahead from last version tag.
with open("VERSION") as f:
    version = f.read().strip()


with open('README.md') as f:
    long_description = f.read()


def find_package_datafiles(package_dir):
    """ Return a list of non-python files in package source tree

    File paths are relative to the top of the package directory provided.
    """
    # TODO: Add exclusion list/glob/regex parameter if necessary.
    non_python = set()
    for dirpath, _, fnames in os.walk(package_dir):
        non_python.update([os.path.relpath(os.path.join(dirpath, fp),
                                           package_dir)
                           for fp in fnames
                           # Things that are NOT python files
                           if PYTHON_FILE_RE.match(fp) is None])
    return list(non_python)


def list_directory_files(dirpath, exclude_dirs=(), exclude_files=()):
    """
    List files and their parent directories in the format required for the
    ``setup`` function ``data_files`` parameter:

        ...
        data_files=[
            ('dir', 'root-relative-file-path'),
            ...
        ],
        ...

    This function is intended to effectively install a directory located in the
    source root as is (e.g. the ``etc`` directory).

    :param dirpath: Base directory to start with. The directory paths returned
        start with this directory.
    :param exclude_dirs: sequence if directory paths (starting from ``dirpath``)
        that should not be included. For example, we don't want the `bin/memex'
        directory to be installed, when gathering data files for `bin`, we call
        this function like:

            list_directory_files('bin', ['bin/memex'])
    :param exclude_files: File names to ignore in directories traversed.

    """
    exclude_dirs = set(ed.strip(' /') for ed in exclude_dirs)
    exclude_files = set(ef.strip() for ef in exclude_files)
    file_paths = []
    for dirpath, dnames, fnames in os.walk(dirpath):
        # Filter out directories to be excluded
        for dn in dnames:
            if os.path.join(dirpath, dn) in exclude_dirs:
                print("skipping:", os.path.join(dirpath, dn))
                del dnames[dnames.index(dn)]
        # filter out excluded files
        fnames = set(fnames).difference(exclude_files)
        # collect directory to file paths reference
        file_paths.append(
            (dirpath, [os.path.join(dirpath, fn) for fn in fnames])
        )
    return file_paths


################################################################################


setuptools.setup(
    name='smqtk',
    version=version,
    description='Python toolkit for pluggable algorithms and data structures '
                'for multimedia-based machine learning',
    long_description=long_description,
    author='Kitware, Inc.',
    author_email='smqtk-developers@kitware.com',
    url='https://github.com/Kitware/SMQTK',
    license='BSD 3-Clause',
    classifiers=[
        'Development Status :: 3 - Alpha',
        'Intended Audience :: Developers',
        'Intended Audience :: Science/Research',
        'License :: OSI Approved :: BSD License',
        'Operating System :: MacOS :: MacOS X',
        'Operating System :: Unix',
        'Programming Language :: Python :: 2',
        'Programming Language :: Python :: 2.7',
        'Topic :: Scientific/Engineering :: Artificial Intelligence',
        'Topic :: Scientific/Engineering :: Image Recognition'
    ],
    platforms=[
        'Linux',
        'Max OS-X',
        'Unix',
        # 'Windows',  # Not tested yet
    ],

    package_dir={'': PYTHON_SRC},
    packages=setuptools.find_packages(PYTHON_SRC),
    package_data={
        'smqtk': find_package_datafiles(os.path.join(PYTHON_SRC, 'smqtk'))
    },
    data_files=list_directory_files('etc'),

    setup_requires=[
        'pytest-runner',
    ],
    install_requires=[
        'flask',
        'flask-basicauth',
        'flask-login',
        'Flask-Cors',
        'imageio',
        'jinja2',
        'jsmin',
        'matplotlib',
        'numpy',
        'pillow',
        'pymongo',
        'requests',
        'scikit-learn',
        'scipy',
        'six',
        'stevedore',
    ],
    tests_require=[
        'coverage',
        'mock',
        'pytest',
        'pytest-cov',
    ],
    extras_require={
        # Various optional dependencies for plugins
        'docs': [
            'livereload',
            'mock',
            'sphinx',
            'sphinx-argparse',
            'sphinx-prompt',
            'sphinx_rtd_theme',
        ],
        'caffe': [
            'protobuf',
            'scikit-image',
        ],
        'magic': [
            'file-magic',
        ],
        'flann': [
            'pyflann>=1.8.4',
        ],
        'libmagic': [
            'file-magic',
        ],
        'postgres': [
            'psycopg2-binary',
        ],
        'solr': [
            'solrpy',
        ],
        'girder': [
            'girder-client',
        ],
    },

    # See entry_points/console_scripts as the preferred method for publishing
    #   executable scripts. Might have redesign how scripts are done if that is
    #   to be used...
    # TODO: Rename camel-case scripts to ``smqtk-...`` format without camel-case
    entry_points={
        'console_scripts': [
            'classifier_kfold_validation = \
                smqtk.bin.classifier_kfold_validation\
                :classifier_kfold_validation',
            'classifier_model_validation = \
                smqtk.bin.classifier_model_validation:main',
            'smqtk-classify-files = smqtk.bin.classifyFiles:main ',
            'compute_classifications = smqtk.bin.compute_classifications:main',
            'compute_hash_codes = smqtk.bin.compute_hash_codes:main',
            'compute_many_descriptors = \
                smqtk.bin.compute_many_descriptors:main',
            'smqtk-compute-descriptor = smqtk.bin.computeDescriptor:main',
            'smqtk-create-file-ingest = smqtk.bin.createFileIngest:main',
            'smqtk-create-girder-ingest = smqtk.bin.createGirderIngest:main',
            'descriptors_to_svmtrain = \
                smqtk.bin.descriptors_to_svmtrainfile:main',
            'generate_image_transform = \
                smqtk.bin.generate_image_transform:main',
            'iqr_app_model_generation = \
                smqtk.bin.iqr_app_model_generation:main',
            'iqrTrainClassifier = smqtk.bin.iqrTrainClassifier:main',
            'make_balltree = smqtk.bin.make_balltree:main',
            'minibatch_kmeans_clusters = \
                smqtk.bin.minibatch_kmeans_clusters:main',
            'smqtk-remove-old-files = smqtk.bin.removeOldFiles:main',
            'smqtk-proxy-manager-server = smqtk.bin.proxyManagerServer:main',
            'runApplication = smqtk.bin.runApplication:main',
            'smqtk-summarize-plugins = smqtk.bin.summarizePlugins:main',
            'train_itq = smqtk.bin.train_itq:main',
            'smqtk-make-train-test-sets = smqtk.bin.make_train_test_sets:main',
            'smqtk-nearest-neighbors = smqtk.bin.nearest_neighbors:main',
            'smqtk-check-images = smqtk.bin.check_images:main'
        ],
    }
)