setup.py

# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
# 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.

"""Cosmos Curator Client Setup.

This script handles the setup and installation process for the Cosmos Curator package.
It reads metadata from pyproject.toml, prepares the build directory structure,
and configures the package for distribution.
"""

import shutil
from pathlib import Path

import tomli
from setuptools import find_packages, setup


def load_metadata() -> tuple[str, str, str, str, str, list[str]]:
    """Load package metadata from pyproject.toml.

    Extracts package name, version, description, and dependencies from the
    pyproject.toml configuration file.

    Returns:
        tuple: Contains name, version, description, and dependencies list.

    """
    with Path("pyproject.toml").open("rb") as f:
        pyproject = tomli.load(f)
    project = pyproject["project"]
    name = project["name"]
    version = project["version"]
    lic = project["license"]
    authors = project["authors"]
    description = project.get("description", "")
    deps = pyproject.get("project", {}).get(name, {}).get("dependencies", [])
    return name, version, lic, authors, description, deps


name, version, lic, authors, description, install_requires = load_metadata()

build_dir = "build"
dist_dir = "dist"
pkg_path = Path(build_dir) / name
src_env_file = Path(name) / "core" / "utils" / "environment.py"
src_init_file = Path(name) / "__init__.py"
dst_core_dir = pkg_path / "core"
dst_utils_dir = dst_core_dir / "utils"
dst_client_dir = pkg_path / "client"

# Ensure build directory exists
Path(build_dir).mkdir(exist_ok=True)

# License header to be used in generated files
copyright_header = [
    "# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.",
    "# SPDX-License-Identifier: Apache-2.0",
    "#",
    '# 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.",
]


def build_package() -> None:
    """Build the package before setup() is called."""
    # Clean build and dist directories
    shutil.rmtree(Path(build_dir), ignore_errors=True)
    shutil.rmtree(Path(dist_dir), ignore_errors=True)

    Path(build_dir).mkdir(exist_ok=True)

    dst_utils_dir.mkdir(parents=True, exist_ok=True)

    client_src = Path(name) / "client"
    if client_src.exists():
        shutil.copytree(client_src, dst_client_dir)

    if src_init_file.exists():
        shutil.copy2(src_init_file, pkg_path / "__init__.py")
    else:
        # Create a default __init__.py with license header if original doesn't exist
        with (pkg_path / "__init__.py").open("w") as f:
            for line in copyright_header:
                f.write(f"{line}\n")

    with (dst_core_dir / "__init__.py").open("w") as f:
        for line in copyright_header:
            f.write(f"{line}\n")

    with (dst_utils_dir / "__init__.py").open("w") as f:
        for line in copyright_header:
            f.write(f"{line}\n")
        f.write('"""Environment."""\n')

    if src_env_file.exists():
        shutil.copy2(src_env_file, dst_utils_dir)

    examples_src = Path("examples")
    examples_dst = pkg_path / "examples"
    if examples_src.exists():
        shutil.copytree(examples_src, examples_dst)


build_package()

setup(
    name=name,
    version=version,
    license=lic,
    author=authors,
    description=description,
    packages=find_packages(where=build_dir, include=[name, f"{name}.*"]),
    include_package_data=True,
    package_dir={"": build_dir},
    package_data={name: ["examples/**/*", "client/nvcf_cli/ncf/launcher/helm_values/*"]},
    install_requires=install_requires,
)