setup.py

# Copyright 2019 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ==============================================================================
"""Setup to install Fairness Indicators."""

import os
import sys
from pathlib import Path

import setuptools

if sys.version_info >= (3, 14):
    sys.exit("Sorry, Python >= 3.14 is not supported")


def select_constraint(default, nightly=None, git_master=None):
    """Select dependency constraint based on TFX_DEPENDENCY_SELECTOR env var."""
    selector = os.environ.get("TFX_DEPENDENCY_SELECTOR")
    if selector == "UNCONSTRAINED":
        return ""
    elif selector == "NIGHTLY" and nightly is not None:
        return nightly
    elif selector == "GIT_MASTER" and git_master is not None:
        return git_master
    else:
        return default


REQUIRED_PACKAGES = [
    "tensorflow>=2.21,<2.22",
    "tensorflow-hub>=0.16.1,<1.0.0",
    "tensorflow-data-validation>=1.21.0,<1.22.0",
    "tensorflow-model-analysis>=0.52.0,<0.53.0",
    "witwidget>=1.4.4,<2",
    "protobuf>=6.0.0,<7.0.0",
    "numpy>=1.23.5,<2.0.0; python_version < '3.13'",
    "numpy>=2.1.0; python_version >= '3.13'",
]

TEST_PACKAGES = [
    "pytest>=8.3.0,<9",
]

with open(Path("./requirements-docs.txt").expanduser().absolute()) as f:
    DOCS_PACKAGES = [req.strip() for req in f.readlines()]

# Get version from version module.
with open("fairness_indicators/version.py") as fp:
    globals_dict = {}
    exec(fp.read(), globals_dict)  # pylint: disable=exec-used
__version__ = globals_dict["__version__"]
with open("README.md", encoding="utf-8") as fh:
    long_description = fh.read()
setuptools.setup(
    name="fairness_indicators",
    version=__version__,
    description="Fairness Indicators",
    long_description=long_description,
    long_description_content_type="text/markdown",
    url="https://github.com/tensorflow/fairness-indicators",
    author="Google LLC",
    author_email="packages@tensorflow.org",
    packages=setuptools.find_packages(exclude=["tensorboard_plugin"]),
    package_data={
        "fairness_indicators": ["documentation/*"],
    },
    python_requires=">=3.10,<4",
    install_requires=REQUIRED_PACKAGES,
    tests_require=REQUIRED_PACKAGES,
    extras_require={"docs": DOCS_PACKAGES, "test": TEST_PACKAGES, "dev": "pre-commit"},
    # PyPI package information.
    classifiers=[
        "Development Status :: 4 - Beta",
        "Intended Audience :: Developers",
        "Intended Audience :: Education",
        "Intended Audience :: Science/Research",
        "License :: OSI Approved :: Apache Software License",
        "Operating System :: OS Independent",
        "Programming Language :: Python :: 3",
        "Programming Language :: Python :: 3.10",
        "Programming Language :: Python :: 3.11",
        "Programming Language :: Python :: 3.12",
        "Programming Language :: Python :: 3.13",
        "Programming Language :: Python :: 3 :: Only",
        "Topic :: Scientific/Engineering",
        "Topic :: Scientific/Engineering :: Mathematics",
        "Topic :: Scientific/Engineering :: Artificial Intelligence",
        "Topic :: Software Development",
        "Topic :: Software Development :: Libraries",
        "Topic :: Software Development :: Libraries :: Python Modules",
    ],
    license="Apache 2.0",
    keywords=(
        "tensorflow model analysis fairness indicators tensorboard machine" " learning"
    ),
)