setup.py

#! /usr/bin/env python3
# -*- coding: utf-8 -*-
# pylint: disable=
# mkvenv: no-deps
""" Debian packaging for the jupyterhub package.

    | Copyright ©  2018 - 2019, 1&1 Group
    | See LICENSE for details.

    This puts the ``jupyterhub`` Python package and its dependencies as released
    on PyPI into a DEB package, using ``dh-virtualenv``.
    The resulting *omnibus package* is thus easily installed to and removed
    from a machine, but is not a ‘normal’ Debian ``python-*`` package.
    Services are controlled by ``systemd`` units.

    See the `GitHub README`_ for more.

    .. _`GitHub README`: https://github.com/mam-dev/debianized-jupyterhub
"""
import io
import os
import re
import sys
import json
import textwrap
import subprocess

try:
    from StringIO import StringIO
except ImportError:
    from io import StringIO

try:
    from rfc822 import Message as rfc822_headers
except ImportError:
    from email import message_from_file as rfc822_headers

try:
    from setuptools import setup
except ImportError as exc:
    raise RuntimeError("setuptools is missing ({0})".format(exc))


# get external project data (and map Debian version semantics to PEP440)
try:
    pkg_version = subprocess.check_output("dpkg-parsechangelog | grep ^Version:", shell=True)
except subprocess.CalledProcessError:
    pkg_version = subprocess.check_output("parsechangelog | grep ^Version:", shell=True)
try:
    pkg_version = pkg_version.decode('ascii')
except (UnicodeDecodeError, AttributeError):
    pass
pkg_version = pkg_version.strip()
upstream_version, maintainer_version = pkg_version.split()[1].rsplit('~', 1)[0].split('-', 1)
maintainer_version = maintainer_version.replace('~~rc', 'rc').replace('~~dev', '.dev')
pypi_version = upstream_version + '.' + maintainer_version

with io.open('debian/control', encoding='utf-8') as control_file:
    data = [x for x in control_file.readlines() if not x.startswith('#')]
    control_cleaned = StringIO(''.join(data))
    deb_source = rfc822_headers(control_cleaned)
    deb_binary = rfc822_headers(control_cleaned)
    if not deb_binary:
        deb_binary = rfc822_headers(StringIO(deb_source.get_payload()))

try:
    doc_string = __doc__.decode('utf-8')
except (UnicodeDecodeError, AttributeError):
    doc_string = __doc__

maintainer, email = re.match(r'(.+) <([^>]+)>', deb_source['Maintainer']).groups()
desc, long_desc = deb_binary['Description'].split('.', 1)
desc, pypi_desc = doc_string.split('\n', 1)
long_desc = textwrap.dedent(pypi_desc) + textwrap.dedent(long_desc).replace('\n.\n', '\n\n')
dev_status = 'Development Status :: 5 - Production/Stable'

# Check for pre-release versions like "1.2-3~~rc1~distro"
if '~~rc' in pkg_version or '~~dev' in pkg_version:
    rc_tag = re.match('.*~~([a-z0-9]+).*', pkg_version).group(1)
    if rc_tag.startswith('dev'):
        rc_tag = '.' + rc_tag
    if rc_tag not in upstream_version:
        upstream_version += rc_tag
    if rc_tag not in pypi_version:
        pypi_version += rc_tag
    dev_status = 'Development Status :: 4 - Beta'

# build setuptools metadata
project = dict(
    name='debianized-' + deb_source['Source'],
    version=pypi_version,
    author=maintainer,
    author_email=email,
    license='BSD 3-clause',
    description=desc.strip(),
    long_description=textwrap.dedent(long_desc).strip(),
    url=deb_source['Homepage'],
    classifiers=[
        # Details at http://pypi.python.org/pypi?:action=list_classifiers
        dev_status,
        'Environment :: Web Environment',
        'Framework :: Jupyter',
        'Intended Audience :: Information Technology',
        'Intended Audience :: System Administrators',
        'Intended Audience :: Science/Research',
        'License :: OSI Approved :: BSD License',
        'Operating System :: POSIX :: Linux',
        'Programming Language :: Python :: 3.5',
        'Programming Language :: Python :: 3.6',
        'Programming Language :: Python :: 3.7',
        'Programming Language :: Python :: Implementation :: CPython',
        'Topic :: Scientific/Engineering :: Artificial Intelligence',
        'Topic :: Scientific/Engineering :: Information Analysis',
        'Topic :: Scientific/Engineering :: Visualization',
        'Topic :: Software Development :: User Interfaces',
        'Topic :: System :: Distributed Computing',
        'Topic :: Text Editors :: Integrated Development Environments (IDE)',
    ],
    keywords='jupyterhub deployment debian-packages dh-virtualenv devops omnibus-packages'.split(),
    install_requires=[
        # core
        'jupyterhub==' + upstream_version,
        'notebook==6.0.3',
        'ipython==7.9.0; python_version < "3.6"',  # Stretch
        'ipython==7.16.1; python_version >= "3.6"',
        'jupyter==1.0.0',
        'ipywidgets==7.5.1',
        'sudospawner==0.5.2',
        'tornado==6.0.4',
        'pycurl==7.43.0.5',  # recommended by server logs
    ],
    extras_require=dict(
        arrow=['pyarrow==1.0.0'],
        base=[
            ##'bottleneck==1.3.1',
            'Cython==0.29.21',  # see also --preinstall in debian/rules
            'networkx==2.4',
            #'nxviz==0.6.1',  # requires Py3.6+, and has frozen/clashing requirements
            'numexpr==2.7.1',
            'numpy==1.19.1',
            'pandas==0.25.3; python_version < "3.6"',  # Stretch
            'pandas==1.0.5; python_version >= "3.6"',
            'pytz==2020.1',
        ],
        docker=['dockerspawner==0.11.1', 'swarmspawner==0.1.0'],
        img=[
            'scikit-image==0.17.2',  # above 50 MiB
        ],
        parquet=['fastparquet==0.4.1', 'parquet-cli==1.3', 'csv2parquet==0.0.9'],
        nlp=[
            'gensim==3.8.3',  # Topic Modelling in Python
            #'polyglot==16.7.4',  # badly maintained, and setup has Unicode problems
            'spacy==2.3.2',  # BIG (several 100 MiB)
        ],
        nltk=['nltk==3.5', 'textblob==0.15.3'],
        ml=[
            'scikit-learn==0.23.1',
            'word2vec==0.11.1',
        ],
        publish=[
            'nbreport==0.7.4',
        ],
        spark=['pyspark==3.0.0', 'pyspark-flame==0.2.6'],  # BIG (several 100 MiB)
        utils=[
            'colour==0.1.5',
            'dfply==0.3.3',
            'jupyter-console==6.1.0',
            'jupyter-contrib-nbextensions==0.5.1',
            'openpyxl==2.6.4; python_version < "3.6"',  # Stretch
            'openpyxl==3.0.4; python_version >= "3.6"',
            'Pillow==7.2.0',
            'qgrid==1.3.1',
            'requests==2.24.0',
            'xlsxwriter==1.2.9',
            'xlrd==1.2.0',
            #'jupytext==1.0.1',  # see https://github.com/mwouts/jupytext/issues/185
        ],
        viz=[
            'seaborn==0.9.1; python_version < "3.6"',  # Stretch
            'seaborn==0.10.1; python_version >= "3.6"',
            'missingno==0.4.2',
            'holoviews[recommended]==1.13.3',
            'colorcet==2.0.2',
            'plotnine==0.5.1; python_version < "3.6"',  # Stretch
            'plotnine==0.7.0; python_version >= "3.6"',
            'wordcloud==1.7.0',
        ],
        vizjs=[
            'plotly==4.9.0', 'plotly_express==0.4.1', 'cufflinks==0.17.3',
            'bokeh==2.1.1',
            'psutil==5.7.2',
            'chartify==3.0.1',
            'altair==4.1.0',  # needs Python 3.5.3+
            'altair_saver==0.5.0',
            'vega==2.6.0; python_version < "3.6"',  # Stretch
            'vega==3.4.0; python_version >= "3.6"',
            'vega_datasets==0.8.0',
            'selenium',  # '==3.141.0',
            'chromedriver-binary==2.46.0', 'phantomjs-binary==2.1.3',
        ],
    ),
    packages=[],
)
DEFAULT_EXTRAS = {'base', 'docker', 'ml', 'publish', 'utils', 'viz', 'vizjs'}
#                 'arrow', 'img', 'nlp', 'nltk', 'parquet', 'spark'
project['extras_require']['full'] = sum(project['extras_require'].values(), [])
project['extras_require']['default'] = sum((v for k, v in project['extras_require'].items()
                                            if k in DEFAULT_EXTRAS), [])


# 'main'
__all__ = ['project']
if __name__ == '__main__':
    if '--metadata' in sys.argv[:2]:
        json.dump(project, sys.stdout, default=repr, indent=4, sort_keys=True)
        sys.stdout.write('\n')
    elif '--tag' in sys.argv[:2]:
        subprocess.call("git tag -a 'v{version}' -m 'Release v{version}'"
                        .format(version=pypi_version), shell=True)
    else:
        setup(**project)