Skip to main content

Custom PEP517 builder for RAPIDS

Project description

RAPIDS PEP517 build backend

rapids-build-backend is an adapter around PEP517 builders that provides support for key RAPIDS requirements. It currently support scikit-build-core and setuptools as the wrapped builder. The package's primary purpose is to automate the various bits of preprocessing that are typically done to RAPIDS package metadata prior to publishing packages. This includes the following notable changes:

  • Modifying the package name to include CUDA suffixes.
  • Updating the git commit embedded in the importable package.
  • Modifying the package's (build, runtime, etc) dependencies to include CUDA suffixes.
  • Filtering out dependencies based on the CUDA version at build time.
  • Updating dependency specifiers to include an alpha specifier to allow pulling nightly dependencies in nightly builds.

Since some of these modifications are only desirable in certain scenarios (wheel vs conda builds vs editable installs), all of these functions are customizable via the project's configuration in pyproject.toml. In cases where more dynamic customization is sensible, suitable environment variables and config_settings are supported during builds of distributions.

Supported configuration

Any option without a default is required.

Option Definition Type Default Supports dynamic modification
allow-nightly-deps If true, append alpha specifiers to dependencies bool true Y
build-backend The wrapped build backend (e.g. setuptools.build_meta) string N
commit-file The file in which to write the git commit hash string "" (No file) N
disable-cuda-suffix If true, don't try to write CUDA suffixes bool false Y
require-cuda If false, builds will succeed even if nvcc is not available bool true Y
requires List of build requirements (in addition to build-system.requires) list[str] [] N

Outstanding questions

  • How should we split up build requirements between build-system and tool.rapids-build-backend? In theory any dependency that doesn't need suffixing could also go into build-system.requires. I think it's easier to teach that all dependencies other than rapids-build-backend itself should to into tool.rapids-build-backend, but I don't know how others feel.

Future improvements

Rejected ideas

  • We could also include the rewrite of VERSION that we use for RAPIDS builds, but this is really more specific to our release process than the general process of building our wheels. I don't think someone building a wheel locally should see the same version as what we produce via CI. If we really wanted we could pull dunamai as a dependency and write a different version here, though.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

rapids_build_backend-0.0.1-py3-none-any.whl (13.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page