setup.py

from setuptools import setup, find_packages
import sys
import os

# PEP0440 compatible formatted version, see:
# https://www.python.org/dev/peps/pep-0440/
#
# release markers:
#   X.Y
#   X.Y.Z   # For bugfix releases
#
# pre-release markers:
#   X.YaN   # Alpha release
#   X.YbN   # Beta release
#   X.YrcN  # Release Candidate
#   X.Y     # Final release

# version.py defines the VERSION and VERSION_SHORT variables.
# We use exec here so we don't import allennlp_semparse whilst setting up.
VERSION = {}
with open("allennlp_rc/version.py") as version_file:
    exec(version_file.read(), VERSION)

# Load requirements.txt with a special case for allennlp so we can handle
# cross-library integration testing.
with open("requirements.txt") as requirements_file:
    install_requirements = requirements_file.readlines()
    install_requirements = [
        r for r in install_requirements if "git+https://github.com/allenai/allennlp" not in r
    ]
    if not os.environ.get("EXCLUDE_ALLENNLP_IN_SETUP"):
        # Warning: This will not give you the desired version if you've already
        # installed allennlp! See https://github.com/pypa/pip/issues/5898.
        #
        # There used to be an alternative to this using `dependency_links`
        # (https://stackoverflow.com/questions/3472430), but pip decided to
        # remove this in version 19 breaking numerous projects in the process.
        # See https://github.com/pypa/pip/issues/6162.
        #
        # As a mitigation, run `pip uninstall allennlp` before installing this
        # package.
        sha = "4749fc3"
        requirement = f"allennlp @ git+https://github.com/allenai/allennlp@{sha}#egg=allennlp"
        install_requirements.append(requirement)

# make pytest-runner a conditional requirement,
# per: https://github.com/pytest-dev/pytest-runner#considerations
needs_pytest = {"pytest", "test", "ptr"}.intersection(sys.argv)
pytest_runner = ["pytest-runner"] if needs_pytest else []

setup_requirements = [
    # add other setup requirements as necessary
] + pytest_runner

setup(
    name="allennlp_reading_comprehension",
    version=VERSION["VERSION"],
    description=(
        "A framework for building reading comprehension models "
        "with AllenNLP, built by the authors of AllenNLP"
    ),
    long_description=open("README.md").read(),
    long_description_content_type="text/markdown",
    classifiers=[
        "Intended Audience :: Science/Research",
        "Development Status :: 3 - Alpha",
        "License :: OSI Approved :: Apache Software License",
        "Programming Language :: Python :: 3.6",
        "Topic :: Scientific/Engineering :: Artificial Intelligence",
    ],
    keywords="allennlp NLP deep learning machine reading semantic parsing parsers",
    url="https://github.com/allenai/allennlp-reading-comprehension",
    author="Allen Institute for Artificial Intelligence",
    author_email="allennlp@allenai.org",
    license="Apache",
    packages=find_packages(exclude=["*.tests", "*.tests.*", "tests.*", "tests"]),
    install_requires=install_requirements,
    setup_requires=setup_requirements,
    tests_require=["pytest", "flaky", "responses>=0.7"],
    include_package_data=True,
    python_requires=">=3.6.1",
    zip_safe=False,
)