setup.py

"""
Usage:

Create ~/.pypirc with info:

    [distutils]
    index-servers =
        pypi

    [pypi]
    repository: https://upload.pypi.org/legacy/
    username: ...
    password: ...

(Not needed anymore) Registering the project: python3 setup.py register
New release: python3 setup.py sdist upload

I had some trouble at some point, and this helped:
pip3 install --user twine
python3 setup.py sdist
twine upload dist/background_zmq_ipython-*

See also MANIFEST.in for included files.

For debugging this script:

python3 setup.py sdist
pip3 install --user dist/...*.tar.gz -v
(Without -v, all stdout/stderr from here will not be shown.)

"""

from distutils.core import setup
import time
from pprint import pprint
import os
import sys
from subprocess import Popen, check_output, PIPE


def debug_print_file(fn):
    print("%s:" % fn)
    if not os.path.exists(fn):
        print("<does not exist>")
        return
    if os.path.isdir(fn):
        print("<dir:>")
        pprint(os.listdir(fn))
        return
    print(open(fn).read())


def parse_pkg_info(fn):
    """
    :param str fn:
    :rtype: dict[str,str]
    """
    res = {}
    for ln in open(fn).read().splitlines():
        if not ln or not ln[:1].strip():
            continue
        key, value = ln.split(": ", 1)
        res[key] = value
    return res


def git_commit_rev(commit="HEAD", git_dir="."):
    if commit is None:
        commit = "HEAD"
    return check_output(["git", "rev-parse", "--short", commit], cwd=git_dir).decode("utf8").strip()


def git_is_dirty(git_dir="."):
    proc = Popen(["git", "diff", "--no-ext-diff", "--quiet", "--exit-code"], cwd=git_dir, stdout=PIPE)
    proc.communicate()
    if proc.returncode == 0:
        return False
    if proc.returncode == 1:
        return True
    raise Exception("unexpected return code %i" % proc.returncode)


def git_commit_date(commit="HEAD", git_dir="."):
    out = check_output(["git", "show", "-s", "--format=%ci", commit], cwd=git_dir).decode("utf8")
    out = out.strip()[:-6].replace(":", "").replace("-", "").replace(" ", ".")
    return out


def git_head_version(git_dir="."):
    commit_date = git_commit_date(git_dir=git_dir)  # like "20190202.154527"
    # rev = git_commit_rev(git_dir=git_dir)
    # is_dirty = git_is_dirty(git_dir=git_dir)
    # Make this distutils.version.StrictVersion compatible.
    return "1.%s" % commit_date


if os.path.exists("PKG-INFO"):
    print("Found existing PKG-INFO.")
    info = parse_pkg_info("PKG-INFO")
    version = info["Version"]
    print("Version via PKG-INFO:", version)
else:
    try:
        version = git_head_version()
        print("Version via Git:", version)
    except Exception as exc:
        print("Exception while getting Git version:", exc)
        sys.excepthook(*sys.exc_info())
        version = time.strftime("1.%Y%m%d.%H%M%S", time.gmtime())
        print("Version via current time:", version)


if os.environ.get("DEBUG", "") == "1":
    debug_print_file(".")
    debug_print_file("PKG-INFO")


setup(
    name='background_zmq_ipython',
    version=version,
    packages=['background_zmq_ipython'],
    package_dir={'background_zmq_ipython': ''},
    description='Background ZMQ IPython/Jupyter kernel',
    author='Albert Zeyer',
    author_email='albzey@gmail.com',
    url='https://github.com/albertz/background-zmq-ipython',
    license='2-clause BSD license',
    long_description=open('README.rst').read(),
    install_requires=open('requirements.txt').read().splitlines(),
    # https://pypi.python.org/pypi?%3Aaction=list_classifiers
    classifiers=[
        'Development Status :: 5 - Production/Stable',
        'Intended Audience :: Developers',
        'Intended Audience :: Education',
        'Intended Audience :: Science/Research',
        'License :: OSI Approved :: BSD License',
        'Operating System :: MacOS :: MacOS X',
        'Operating System :: Microsoft :: Windows',
        'Operating System :: POSIX',
        'Operating System :: Unix',
        'Programming Language :: Python',
        'Topic :: Software Development :: Libraries :: Python Modules',
    ]
)