Schema¶
The full schema for the tool.scikit-build
table is below:
https://github.com/scikit-build/scikit-build-core/blob/main/src/scikit_build_core/resources/scikit-build.schema.json |
||||||||
Scikit-build-core’s settings. |
||||||||
type |
object |
|||||||
properties |
||||||||
|
type |
object |
||||||
properties |
||||||||
|
DEPRECATED in 0.8; use version instead. |
|||||||
type |
string |
|||||||
|
The versions of CMake to allow as a python-compatible specifier. |
|||||||
type |
string |
|||||||
|
A list of args to pass to CMake when configuring the project. |
|||||||
type |
array |
|||||||
items |
type |
string |
||||||
|
A table of defines to pass to CMake when configuring the project. Additive. |
|||||||
type |
object |
|||||||
patternProperties |
||||||||
|
oneOf |
oneOf |
type |
string |
||||
type |
boolean |
|||||||
type |
array |
|||||||
items |
type |
string |
||||||
type |
object |
|||||||
properties |
||||||||
|
type |
string |
||||||
minLength |
1 |
|||||||
|
oneOf |
type |
string |
|||||
type |
boolean |
|||||||
type |
array |
|||||||
items |
type |
string |
||||||
additionalProperties |
False |
|||||||
|
DEPRECATED in 0.10, use build.verbose instead. |
|||||||
type |
boolean |
|||||||
|
The build type to use when building the project. |
|||||||
type |
string |
|||||||
default |
Release |
|||||||
|
The source directory to use when building the project. |
|||||||
type |
string |
|||||||
default |
. |
|||||||
|
DEPRECATED in 0.10; use build.targets instead. |
|||||||
type |
array |
|||||||
items |
type |
string |
||||||
additionalProperties |
False |
|||||||
|
type |
object |
||||||
properties |
||||||||
|
DEPRECATED in 0.8; use version instead. |
|||||||
type |
string |
|||||||
|
The versions of Ninja to allow. |
|||||||
type |
string |
|||||||
default |
|
|||||||
|
Use Make as a fallback if a suitable Ninja executable is not found. |
|||||||
type |
boolean |
|||||||
default |
True |
|||||||
additionalProperties |
False |
|||||||
|
type |
object |
||||||
properties |
||||||||
|
The logging level to display. |
|||||||
enum |
NOTSET, DEBUG, INFO, WARNING, ERROR, CRITICAL |
|||||||
default |
WARNING |
|||||||
additionalProperties |
False |
|||||||
|
type |
object |
||||||
properties |
||||||||
|
Files to include in the SDist even if they are skipped by default. Supports gitignore syntax. |
|||||||
type |
array |
|||||||
items |
type |
string |
||||||
|
Files to exclude from the SDist even if they are included by default. Supports gitignore syntax. |
|||||||
type |
array |
|||||||
items |
type |
string |
||||||
|
Try to build a reproducible distribution. |
|||||||
type |
boolean |
|||||||
default |
True |
|||||||
|
If set to True, CMake will be run before building the SDist. |
|||||||
type |
boolean |
|||||||
default |
False |
|||||||
additionalProperties |
False |
|||||||
|
type |
object |
||||||
properties |
||||||||
|
A list of packages to auto-copy into the wheel. |
|||||||
oneOf |
type |
array |
||||||
items |
type |
string |
||||||
type |
object |
|||||||
patternProperties |
||||||||
|
type |
string |
||||||
|
The Python version tag used in the wheel file. |
|||||||
type |
string |
|||||||
default |
||||||||
|
Fill out extra tags that are not required. |
|||||||
type |
boolean |
|||||||
default |
False |
|||||||
|
The CMake install prefix relative to the platlib wheel path. |
|||||||
type |
string |
|||||||
default |
||||||||
|
A list of license files to include in the wheel. Supports glob patterns. |
|||||||
type |
array |
|||||||
items |
type |
string |
||||||
|
Run CMake as part of building the wheel. |
|||||||
type |
boolean |
|||||||
default |
True |
|||||||
|
Target the platlib or the purelib. |
|||||||
type |
boolean |
|||||||
|
A set of patterns to exclude from the wheel. |
|||||||
type |
array |
|||||||
items |
type |
string |
||||||
|
The build tag to use for the wheel. If empty, no build tag is used. |
|||||||
type |
string |
|||||||
default |
||||||||
additionalProperties |
False |
|||||||
|
type |
object |
||||||
properties |
||||||||
|
If CMake is less than this value, backport a copy of FindPython. |
|||||||
type |
string |
|||||||
default |
3.26.1 |
|||||||
additionalProperties |
False |
|||||||
|
type |
object |
||||||
properties |
||||||||
|
Select the editable mode to use. Can be “redirect” (default) or “inplace”. |
|||||||
enum |
redirect, inplace |
|||||||
default |
redirect |
|||||||
|
Turn on verbose output for the editable mode rebuilds. |
|||||||
type |
boolean |
|||||||
default |
True |
|||||||
|
Rebuild the project when the package is imported. |
|||||||
type |
boolean |
|||||||
default |
False |
|||||||
additionalProperties |
False |
|||||||
|
type |
object |
||||||
properties |
||||||||
|
Extra args to pass directly to the builder in the build step. |
|||||||
type |
array |
|||||||
items |
type |
string |
||||||
|
The build targets to use when building the project. |
|||||||
type |
array |
|||||||
items |
type |
string |
||||||
|
Verbose printout when building. |
|||||||
type |
boolean |
|||||||
default |
False |
|||||||
|
Additional |
|||||||
type |
array |
|||||||
items |
type |
string |
||||||
additionalProperties |
False |
|||||||
|
type |
object |
||||||
properties |
||||||||
|
The components to install. |
|||||||
type |
array |
|||||||
items |
type |
string |
||||||
|
Whether to strip the binaries. |
|||||||
type |
boolean |
|||||||
additionalProperties |
False |
|||||||
|
type |
array |
||||||
items |
oneOf |
type |
object |
|||||
properties |
||||||||
|
The path (relative to platlib) for the file to generate. |
|||||||
type |
string |
|||||||
minLength |
1 |
|||||||
|
The template string to use for the file. |
|||||||
type |
string |
|||||||
minLength |
1 |
|||||||
|
The place to put the generated file. |
|||||||
enum |
install, build, source |
|||||||
default |
install |
|||||||
additionalProperties |
False |
|||||||
type |
object |
|||||||
properties |
||||||||
|
The path (relative to platlib) for the file to generate. |
|||||||
type |
string |
|||||||
minLength |
1 |
|||||||
|
The path to the template file. If empty, a template must be set. |
|||||||
type |
string |
|||||||
minLength |
1 |
|||||||
|
The place to put the generated file. |
|||||||
enum |
install, build, source |
|||||||
default |
install |
|||||||
additionalProperties |
False |
|||||||
|
type |
object |
||||||
properties |
||||||||
|
A message to print after a build failure. |
|||||||
type |
string |
|||||||
default |
||||||||
|
A message to print after a successful build. |
|||||||
type |
string |
|||||||
default |
||||||||
additionalProperties |
False |
|||||||
|
type |
object |
||||||
properties |
||||||||
|
Add the python build environment site_packages folder to the CMake prefix paths. |
|||||||
type |
boolean |
|||||||
default |
True |
|||||||
additionalProperties |
False |
|||||||
|
List dynamic metadata fields and hook locations in this table. |
|||||||
type |
object |
|||||||
properties |
||||||||
|
#/$defs/metadata |
|||||||
|
#/$defs/metadata |
|||||||
|
#/$defs/metadata |
|||||||
|
#/$defs/metadata |
|||||||
|
#/$defs/metadata |
|||||||
|
#/$defs/metadata |
|||||||
|
#/$defs/metadata |
|||||||
|
#/$defs/metadata |
|||||||
|
#/$defs/metadata |
|||||||
|
#/$defs/metadata |
|||||||
|
#/$defs/metadata |
|||||||
|
#/$defs/metadata |
|||||||
|
#/$defs/metadata |
|||||||
|
#/$defs/metadata |
|||||||
|
#/$defs/metadata |
|||||||
additionalProperties |
False |
|||||||
|
Strictly check all config options. |
|||||||
type |
boolean |
|||||||
default |
True |
|||||||
|
Enable early previews of features not finalized yet. |
|||||||
type |
boolean |
|||||||
default |
False |
|||||||
|
If set, this will provide a method for backward compatibility. |
|||||||
type |
string |
|||||||
|
The CMake build directory. Defaults to a unique temporary directory. |
|||||||
type |
string |
|||||||
default |
||||||||
|
Immediately fail the build. This is only useful in overrides. |
|||||||
type |
boolean |
|||||||
default |
False |
|||||||
|
A list of overrides to apply to the settings, based on the |
|||||||
type |
array |
|||||||
items |
type |
object |
||||||
properties |
||||||||
|
anyOf |
#/$defs/if_overrides |
||||||
type |
object |
|||||||
properties |
||||||||
|
#/$defs/if_overrides |
|||||||
additionalProperties |
False |
|||||||
|
type |
object |
||||||
properties |
||||||||
|
type |
object |
||||||
properties |
||||||||
|
#/$defs/inherit |
|||||||
|
#/$defs/inherit |
|||||||
|
#/$defs/inherit |
|||||||
additionalProperties |
False |
|||||||
|
type |
object |
||||||
properties |
||||||||
|
#/$defs/inherit |
|||||||
|
#/$defs/inherit |
|||||||
additionalProperties |
False |
|||||||
|
type |
object |
||||||
properties |
||||||||
|
#/$defs/inherit |
|||||||
|
#/$defs/inherit |
|||||||
|
#/$defs/inherit |
|||||||
additionalProperties |
False |
|||||||
|
type |
object |
||||||
properties |
||||||||
|
#/$defs/inherit |
|||||||
|
#/$defs/inherit |
|||||||
|
#/$defs/inherit |
|||||||
additionalProperties |
False |
|||||||
|
type |
object |
||||||
properties |
||||||||
|
#/$defs/inherit |
|||||||
additionalProperties |
False |
|||||||
additionalProperties |
False |
|||||||
|
#/properties/cmake |
|||||||
|
#/properties/ninja |
|||||||
|
#/properties/logging |
|||||||
|
#/properties/sdist |
|||||||
|
#/properties/wheel |
|||||||
|
#/properties/backport |
|||||||
|
#/properties/editable |
|||||||
|
#/properties/build |
|||||||
|
#/properties/install |
|||||||
|
#/properties/generate |
|||||||
|
#/properties/messages |
|||||||
|
#/properties/search |
|||||||
|
#/properties/metadata |
|||||||
|
#/properties/strict-config |
|||||||
|
#/properties/experimental |
|||||||
|
#/properties/minimum-version |
|||||||
|
#/properties/build-dir |
|||||||
|
#/properties/fail |
|||||||
additionalProperties |
False |
|||||||
minProperties |
2 |
|||||||
additionalProperties |
False |
|||||||
$defs |
||||||||
|
type |
object |
||||||
properties |
||||||||
|
type |
string |
||||||
|
type |
string |
||||||
|
type |
object |
||||||
properties |
||||||||
|
The version of scikit-build-version. Takes a specifier set. |
|||||||
type |
string |
|||||||
|
The two-digit Python version. Takes a specifier set. |
|||||||
type |
string |
|||||||
|
The value of |
|||||||
type |
string |
|||||||
|
Derived from |
|||||||
type |
string |
|||||||
|
The value of |
|||||||
type |
string |
|||||||
|
The value of |
|||||||
type |
string |
|||||||
|
The value of |
|||||||
type |
string |
|||||||
|
The state of the build, one of |
|||||||
type |
string |
|||||||
|
Whether the build is from an sdist. |
|||||||
type |
boolean |
|||||||
|
Matches if the build fails. A build will be retried if there is at least one matching override with this set to true. |
|||||||
type |
boolean |
|||||||
|
The version of CMake found on the system. Takes a specifier set. |
|||||||
type |
string |
|||||||
|
Whether a cmake wheel is known to be provided for this system. |
|||||||
type |
boolean |
|||||||
|
A sorted string of the abi flags. Takes a regex. |
|||||||
type |
string |
|||||||
|
A table of environment variables mapped to either string regexs, or booleans. Valid ‘truthy’ environment variables are case insensitive |
|||||||
type |
object |
|||||||
patternProperties |
||||||||
|
oneOf |
type |
string |
|||||
type |
boolean |
|||||||
additionalProperties |
False |
|||||||
minProperties |
1 |
|||||||
additionalProperties |
False |
|||||||
minProperties |
1 |
|||||||
|
enum |
none, append, prepend |
||||||
default |
none |