From 92dd262ddaa61bca5cc36493f354afa85189d0d7 Mon Sep 17 00:00:00 2001 From: James Lamb Date: Thu, 14 Nov 2024 12:18:16 -0600 Subject: [PATCH] enforce wheel size limits, README formatting in CI (#643) Contributes to https://github.com/rapidsai/build-planning/issues/110 Proposes adding 2 types of validation on wheels in CI, to ensure we continue to produce wheels that are suitable for PyPI. * checks on wheel size (compressed), - *to be sure they're under PyPI limits* - *and to prompt discussion on PRs that significantly increase wheel sizes* * checks on README formatting - *to ensure they'll render properly as the PyPI project homepages* - *e.g. like how https://github.com/scikit-learn/scikit-learn/blob/main/README.rst becomes https://pypi.org/project/scikit-learn/* Authors: - James Lamb (https://github.com/jameslamb) Approvers: - Bradley Dice (https://github.com/bdice) - Ajay Thorve (https://github.com/AjayThorve) URL: https://github.com/rapidsai/cuxfilter/pull/643 --- ci/build_wheel.sh | 2 ++ ci/validate_wheel.sh | 18 ++++++++++++++++++ python/pyproject.toml | 8 ++++++++ 3 files changed, 28 insertions(+) create mode 100755 ci/validate_wheel.sh diff --git a/ci/build_wheel.sh b/ci/build_wheel.sh index d1be578b..4fb8091c 100755 --- a/ci/build_wheel.sh +++ b/ci/build_wheel.sh @@ -16,4 +16,6 @@ cd "${package_dir}" python -m pip wheel . -w dist -v --no-deps --disable-pip-version-check +../ci/validate_wheel.sh dist + RAPIDS_PY_WHEEL_NAME="${package_name}_${RAPIDS_PY_CUDA_SUFFIX}" RAPIDS_PY_WHEEL_PURE="1" rapids-upload-wheels-to-s3 dist diff --git a/ci/validate_wheel.sh b/ci/validate_wheel.sh new file mode 100755 index 00000000..60a80fce --- /dev/null +++ b/ci/validate_wheel.sh @@ -0,0 +1,18 @@ +#!/bin/bash +# Copyright (c) 2024, NVIDIA CORPORATION. + +set -euo pipefail + +wheel_dir_relative_path=$1 + +rapids-logger "validate packages with 'pydistcheck'" + +pydistcheck \ + --inspect \ + "$(echo ${wheel_dir_relative_path}/*.whl)" + +rapids-logger "validate packages with 'twine'" + +twine check \ + --strict \ + "$(echo ${wheel_dir_relative_path}/*.whl)" diff --git a/python/pyproject.toml b/python/pyproject.toml index a5f7159c..e2c1d374 100644 --- a/python/pyproject.toml +++ b/python/pyproject.toml @@ -69,6 +69,14 @@ license-files = ["LICENSE"] [tool.setuptools.dynamic] version = {file = "cuxfilter/VERSION"} +[tool.pydistcheck] +select = [ + "distro-too-large-compressed", +] + +# PyPI limit is 100 MiB, fail CI before we get too close to that +max_allowed_size_compressed = '75M' + [tool.pytest.ini_options] filterwarnings = [ "error::FutureWarning",