learnware/setup.py

import os

from setuptools import find_packages, setup


def read(rel_path: str) -> str:
    here = os.path.abspath(os.path.dirname(__file__))
    with open(os.path.join(here, rel_path), encoding="utf-8") as fp:
        return fp.read()


def get_version(rel_path: str) -> str:
    for line in read(rel_path).splitlines():
        if line.startswith("__version__"):
            delim = '"' if '"' in line else "'"
            return line.split(delim)[1]
    raise RuntimeError("Unable to find version string.")


# Package meta-data.
NAME = "learnware"
DESCRIPTION = "The learnware package supports the submission, usability testing, organization, identification, deployment, and reuse of learnware."
REQUIRES_PYTHON = ">=3.6.0"
VERSION = get_version("learnware/__init__.py")


# BEFORE importing setuptools, remove MANIFEST. Otherwise it may not be
# properly updated when the contents of directories change (true for distutils,
# not sure about setuptools).
if os.path.exists("MANIFEST"):
    os.remove("MANIFEST")


# What packages are required for this module to be executed?
# `estimator` may depend on other packages. In order to reduce dependencies, it is not written here.
REQUIRED = [
    "numpy>=1.20.0",
    "pandas>=0.25.1",
    "scipy>=1.0.0",
    "tqdm>=4.65.0",
    "scikit-learn>=0.22",
    "joblib>=1.2.0",
    "pyyaml>=6.0",
    "fire>=0.3.1",
    "psutil>=5.9.4",
    "sqlalchemy>=2.0.21",
    "shortuuid>=1.0.11",
    "docker>=6.1.3",
    "rapidfuzz>=3.4.0",
    "langdetect>=1.0.9",
    "huggingface-hub<0.18",
    "transformers>=4.34.1",
    "portalocker>=2.0.0",
    "qpsolvers[clarabel]>=4.0.1",
    "geatpy>=2.7.0;python_version<'3.11'",
]

DEV_REQUIRED = [
    # For documentations
    "sphinx",
    "sphinx_book_theme==0.3.3",
    # CI dependencies
    "pytest>=3",
    "wheel",
    "setuptools",
    "pylint",
    # For static analysis
    "mypy<0.981",
    "flake8",
    "black==23.1.0",
    "pre-commit",
]

FULL_REQUIRED = [
    # The default full requirements for learnware package
    "torch==2.0.1",
    "torchvision==0.15.2",
    "torch-optimizer>=0.3.0",
    "lightgbm>=3.3.0",
    "sentence_transformers==2.2.2",
    "fast_pytorch_kmeans==0.2.0.1",
]

here = os.path.abspath(os.path.dirname(__file__))
with open(os.path.join(here, "README.md"), encoding="utf-8") as f:
    long_description = f.read()


if __name__ == "__main__":
    setup(
        name=NAME,
        version=VERSION,
        license="Apache-2.0 Licence",
        url="https://github.com/Learnware-LAMDA/learnware",
        packages=find_packages(),
        include_package_data=True,
        description=DESCRIPTION,
        long_description=long_description,
        long_description_content_type="text/markdown",
        python_requires=REQUIRES_PYTHON,
        install_requires=REQUIRED,
        extras_require={
            "dev": DEV_REQUIRED,
            "full": FULL_REQUIRED,
        },
        classifiers=[
            "Intended Audience :: Science/Research",
            "Intended Audience :: Developers",
            "Programming Language :: Python",
            "Topic :: Software Development",
            "Topic :: Scientific/Engineering",
            "Operating System :: POSIX :: Linux",
            "Operating System :: Microsoft :: Windows",
            "Programming Language :: Python :: 3.8",
            "Programming Language :: Python :: 3.9",
            "Programming Language :: Python :: 3.10",
            "Programming Language :: Python :: 3.11",
        ],
    )