From 5c19d0aca8c9151502159925d740155b41865728 Mon Sep 17 00:00:00 2001 From: Stanislav Levin Date: Thu, 17 Nov 2022 20:40:45 +0300 Subject: [PATCH] readme: Update examples for passing config settings to setuptools MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit As of 64.0.0 `setuptools` deprecated usage of `--global-option`. https://setuptools.pypa.io/en/latest/history.html#v64-0-0 https://setuptools.pypa.io/en/latest/history.html#deprecations: > [#3380](https://github.com/pypa/setuptools/issues/3380): Passing some types of parameters via --global-option to setuptools [PEP 517](https://peps.python.org/pep-0517/)/[PEP 660](https://peps.python.org/pep-0660/) backend is now considered deprecated. The user can pass the same arbitrary parameter via --build-option (--global-option is now reserved for flags like --verbose or --quiet). > > Both --build-option and --global-option are supported as a transitional effort (a.k.a. “escape hatch”). In the future a proper list of allowed config_settings may be created. Fixes: https://github.com/stanislavlevin/pyproject_installer/issues/17 Signed-off-by: Stanislav Levin --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f5710a6..48dcd0c 100644 --- a/README.md +++ b/README.md @@ -113,7 +113,10 @@ one(wheel). description: ad-hoc configuration for build backend as dumped JSON dictionary default: None -Example of passing config_settings for setuptools backend: +Example of passing config_settings for setuptools>=64.0.0: +python -m pyproject_installer build --backend-config-settings='{"--build-option": ["--python-tag=sometag", "--build-number=123"]}' + +Example of passing config_settings for setuptools<64.0.0: python -m pyproject_installer build --backend-config-settings='{"--global-option": ["--python-tag=sometag", "--build-number=123"]}' Example of passing config_settings for pdm backend: