setup.py

#!/usr/bin/env python
# -*- encoding: utf-8 -*-

from __future__ import absolute_import
from __future__ import print_function

import io
from glob import glob
from os.path import basename
from os.path import dirname
from os.path import join
from os.path import splitext
import re
import sys

from setuptools import find_packages
from setuptools import setup


version = '2.2.1'


#### Small hack to force using a plain version number if the option
#### --plain-version is passed to setup.py

USE_DEFAULT_VERSION = False
try:
    sys.argv.remove('--use-default-version')
    USE_DEFAULT_VERSION = True
except ValueError:
    pass
####

def get_version(default=version, template='{tag}.{distance}.{commit}{dirty}',
                use_default=USE_DEFAULT_VERSION):
    """
    Return a version collected from git if possible or fall back to an
    hard-coded default version otherwise. If `use_default` is True,
    always use the default version.
    """
    if use_default:
        return default
    try:
        tag, distance, commit, dirty = get_git_version()
        if not distance and not dirty:
            # we are from a clean Git tag: use tag
            return tag

        distance = 'post{}'.format(distance)
        if dirty:
            time_stamp = get_time_stamp()
            dirty = '.dirty.' + get_time_stamp()
        else:
            dirty = ''

        return template.format(**locals())
    except:
        # no git data: use default version
        return default


def get_time_stamp():
    """
    Return a numeric UTC time stamp without microseconds.
    """
    from datetime import datetime
    return (datetime.isoformat(datetime.utcnow()).split('.')[0]
            .replace('T', '').replace(':', '').replace('-', ''))


def get_git_version():
    """
    Return version parts from Git or raise an exception.
    """
    from subprocess import check_output, STDOUT
    # this may fail with exceptions
    cmd = 'git', 'describe', '--tags', '--long', '--dirty',
    version = check_output(cmd, stderr=STDOUT).strip()
    dirty = version.endswith('-dirty')
    tag, distance, commit = version.split('-')[:3]
    # lower tag and strip V prefix in tags
    tag = tag.lower().lstrip('v ').strip()
    # strip leading g from git describe commit
    commit = commit.lstrip('g').strip()
    return tag, int(distance), commit, dirty


def read(*names, **kwargs):
    return io.open(
        join(dirname(__file__), *names),
        encoding=kwargs.get('encoding', 'utf8')
    ).read()


setup(
    name='scancode-server',
    version=get_version(),
    license='Apache-2.0 with ScanCode acknowledgment and CC0-1.0 and others',
    description=
        'ScanCode is a tool to scan code for license, copyright, package '
        'and their documented dependencies and other interesting facts.',
    long_description=read('README.md'),
    author='ScanCode',
    author_email='info@aboutcode.org',
    url='https://github.com/nexB/scancode-server',
    packages=find_packages('src'),
    package_dir={'': 'src'},
    py_modules=[splitext(basename(path))[0] for path in glob('src/*.py')],
    include_package_data=True,
    zip_safe=False,
    classifiers=[
        # complete classifier list: http://pypi.python.org/pypi?%3Aaction=list_classifiers
        'Development Status :: 5 - Production/Stable',
        'Intended Audience :: Developers',
        'License :: OSI Approved :: Apache Software License',
        'License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication',
        'Programming Language :: Python',
        'Programming Language :: Python :: 2.7',
        'Topic :: Utilities',
    ],
    keywords=[
        'open source', 'scan', 'license', 'package', 'dependency',
        'copyright', 'filetype', 'author', 'extract', 'licensing',
    ],
    install_requires=[
        # cluecode
        # Some nltk version ranges are buggy
        'nltk >= 3.2, < 4.0',
        'publicsuffix2',
        'py2-ipaddress >= 2.0, <3.0',
        'url >= 0.1.4',

        # extractcode
        'patch >= 1.15, < 1.20 ',
        # to work around bug http://bugs.python.org/issue19839
        # on multistream bzip2 files: this can removed in Python 3.
        'bz2file >= 0.98',

        # commoncode
        'backports.os == 0.1.1',
        'future >= 0.16.0, < 0.17.0',
        'text-unidecode >= 1.0, < 2.0',

        # licensedcode
        'bitarray >= 0.8.1, < 1.0.0',
        'intbitset >= 2.3.0,  < 3.0',
        'pyahocorasick >= 1.1, < 1.2',
        'PyYAML >= 3.0, <4.0',

        # textcode
        'Beautifulsoup >= 3.2.0, <4.0.0',
        'Beautifulsoup4 >= 4.3.0, <5.0.0',
        'html5lib',
        'six',
        'pdfminer.six >= 20170720',
        'pycryptodome >= 3.4',

        # typecode
        'binaryornot >= 0.4.0',
        'chardet >= 3.0.0, <4.0.0',
        'pygments >= 2.0.1, <3.0.0',

        # packagedcode
        'attrs >=16.0, < 17.0',
        'pymaven-patch >= 0.2.4',
        'requests >= 2.7.0, < 3.0.0',
        'schematics_patched',

        # scancode
        'click >= 6.0.0, < 7.0.0',
        'colorama >= 0.3.9',
        'pluggy >= 0.4.0, < 1.0',

        # scancode outputs
        'jinja2 >= 2.7.0, < 3.0.0',
        'MarkupSafe >= 0.23',
        'simplejson',
        'spdx-tools >= 0.5.4',
        'unicodecsv',

        # ScanCode caching and locking
        'psutil >= 5.0.0, < 6.0.0',
        'yg.lockfile >= 2.0.1, < 3.0.0',
            # used by yg.lockfile
            'contextlib2', 'pytz', 'tempora', 'jaraco.timing',
        'zc.lockfile >= 1.0.0, < 2.0.1',
    ],
    extras_require={
        ':platform_system == "Windows"': ['lxml == 3.6.0'],
        ':platform_system == "Linux"': ['lxml == 3.6.4'],
        ':platform_system == "Darwin"': ['lxml == 3.6.4'],
    },
    entry_points={
        'console_scripts': [
            'scancode = scancode.cli:scancode',
            'extractcode = scancode.extract_cli:extractcode',
        ],

        # scancode_output_writers is an entry point to define plugins
        # that write a scan output in a given format.
        # See the plugincode.output module for details and doc.
        # note: the "name" of the entrypoint (e.g "html") becomes the
        # ScanCode command line  --format option used to enable a given
        # format plugin
        'scancode_output_writers': [
            'html = formattedcode.format_templated:write_html',
            'html-app = formattedcode.format_templated:write_html_app',
            'json = formattedcode.format_json:write_json_compact',
            'json-pp = formattedcode.format_json:write_json_pretty_printed',
            'spdx-tv = formattedcode.format_spdx:write_spdx_tag_value',
            'spdx-rdf = formattedcode.format_spdx:write_spdx_rdf',
            'csv = formattedcode.format_csv:write_csv',
            'jsonlines = formattedcode.format_jsonlines:write_jsonlines',
        ],

        # scancode_post_scan is an entry point for post_scan_plugins.
        # See plugincode.post_scan module for details and doc.
        # note: the "name" of the entrypoint (e.g only-findings)
        # becomes the ScanCode CLI boolean flag used to enable a
        # given post_scan plugin
        'scancode_post_scan': [
            'only-findings = scancode.plugin_only_findings:process_only_findings',
            'mark-source = scancode.plugin_mark_source:process_mark_source',
        ],

        # scancode_pre_scan is an entry point to define pre_scan plugins.
        # See plugincode.pre_scan module for details and doc.
        # note: the "name" of the entrypoint (e.g ignore) will be used for
        # the option name which passes the input to the given pre_scan plugin
        'scancode_pre_scan': [
            'ignore = scancode.plugin_ignore:ProcessIgnore',
        ]
    },
)