From c960cbc437ba5cdc51553977b421bc6b455188b8 Mon Sep 17 00:00:00 2001
From: James Lamb <jlamb@nvidia.com>
Date: Fri, 15 Nov 2024 15:45:14 -0600
Subject: [PATCH] enforce wheel size limits, README formatting in CI (#19)

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:
  - Erik Welch (https://github.com/eriknw)
  - Bradley Dice (https://github.com/bdice)

URL: https://github.com/rapidsai/nx-cugraph/pull/19
---
 ci/build_wheel_nx-cugraph.sh |  2 +-
 ci/validate_wheel.sh         | 18 ++++++++++++++++++
 pyproject.toml               |  8 ++++++++
 3 files changed, 27 insertions(+), 1 deletion(-)
 create mode 100755 ci/validate_wheel.sh

diff --git a/ci/build_wheel_nx-cugraph.sh b/ci/build_wheel_nx-cugraph.sh
index 706adb793..55f9eb1ee 100755
--- a/ci/build_wheel_nx-cugraph.sh
+++ b/ci/build_wheel_nx-cugraph.sh
@@ -3,5 +3,5 @@
 
 set -euo pipefail
 
-#                   pkg-name   pkg-dir
 ./ci/build_wheel.sh nx-cugraph .
+./ci/validate_wheel.sh dist
diff --git a/ci/validate_wheel.sh b/ci/validate_wheel.sh
new file mode 100755
index 000000000..60a80fce6
--- /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/pyproject.toml b/pyproject.toml
index 91a211461..300e17a7a 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -153,6 +153,14 @@ exclude_lines = [
     "raise NotImplementedError",
 ]
 
+[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.ruff]
 # https://github.com/charliermarsh/ruff/
 line-length = 88