diff --git a/src/api/json/catalog.json b/src/api/json/catalog.json index 1a297316f67..115b1f30840 100644 --- a/src/api/json/catalog.json +++ b/src/api/json/catalog.json @@ -839,6 +839,12 @@ "fileMatch": ["cibuildwheel.toml", ".cibuildwheel.toml"], "url": "https://json.schemastore.org/cibuildwheel.json" }, + { + "name": "partial-cibuildwheel", + "description": "cibuildwheel, a Python redistributable wheel builder", + "fileMatch": [], + "url": "https://json.schemastore.org/partial-cibuildwheel.json" + }, { "name": "CityJSON", "description": "the representation of 3D city models", @@ -3153,6 +3159,12 @@ "fileMatch": [], "url": "https://json.schemastore.org/poetry.json" }, + { + "name": "Partial-poetry", + "description": "Poetry, a Python packaging tool", + "fileMatch": [], + "url": "https://json.schemastore.org/partial-poetry.json" + }, { "name": "plagiarize.yaml", "description": "Yaml Plagiarize", @@ -3735,6 +3747,12 @@ "fileMatch": [], "url": "https://json.schemastore.org/setuptools.json" }, + { + "name": "Partial-Setuptools", + "description": "Setuptools, the classic Python buildsystem", + "fileMatch": [], + "url": "https://json.schemastore.org/partial-setuptools.json" + }, { "name": "sfdx-hardis configuration", "description": "Configuration file for sfdx-hardis Salesforce DX plugin", @@ -5057,6 +5075,12 @@ "fileMatch": [], "url": "https://json.schemastore.org/scikit-build.json" }, + { + "name": "partial-scikit-build", + "description": "Pyproject configuration for scikit-build-core", + "fileMatch": [], + "url": "https://json.schemastore.org/partial-scikit-build.json" + }, { "name": "StackHawk Scanner Configuration", "description": "StackHawk Scanner configuration files", diff --git a/src/schema-validation.json b/src/schema-validation.json index 73e80c2661a..076a2adfbe1 100644 --- a/src/schema-validation.json +++ b/src/schema-validation.json @@ -778,17 +778,45 @@ "unknownKeywords": ["x-taplo", "x-taplo-info"] } }, + { + "cibuildwheel.json": { + "externalSchema": ["partial-cibuildwheel.json"] + } + }, + { + "setuptools.json": { + "externalSchema": ["partial-setuptools.json"], + "unknownFormat": [ + "python-module-name", + "pep508-identifier", + "python-qualified-identifier", + "python-identifier", + "pep561-stub-name" + ] + } + }, + { + "scikit-build.json": { + "externalSchema": ["partial-scikit-build.json"] + } + }, + { + "poetry.json": { + "externalSchema": ["partial-poetry.json"] + } + }, { "pyproject.json": { "externalSchema": [ - "cibuildwheel.json", "hatch.json", + "partial-cibuildwheel.json", "partial-mypy.json", "partial-pdm.json", + "partial-poetry.json", + "partial-scikit-build.json", + "partial-setuptools.json", "poetry.json", - "ruff.json", - "scikit-build.json", - "setuptools.json" + "ruff.json" ], "unknownKeywords": ["x-taplo", "x-taplo-info"], "unknownFormat": [ @@ -825,7 +853,7 @@ } }, { - "setuptools.json": { + "partial-setuptools.json": { "unknownFormat": [ "python-module-name", "pep508-identifier", diff --git a/src/schemas/json/cibuildwheel.json b/src/schemas/json/cibuildwheel.json index f5536dafb18..fef7e5419ac 100644 --- a/src/schemas/json/cibuildwheel.json +++ b/src/schemas/json/cibuildwheel.json @@ -1,692 +1,16 @@ { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://json.schemastore.org/cibuildwheel.json", - "description": "cibuildwheel's toml file, generated with ./bin/generate_schema.py --schemastore from cibuildwheel.", + "description": "cibuildwheel's toml file, uses the same source as pyproject.toml.", "type": "object", + "additionalProperties": false, "properties": { "tool": { "type": "object", + "additionalProperties": false, "properties": { "cibuildwheel": { - "type": "object", - "additionalProperties": false, - "properties": { - "archs": { - "description": "Change the architectures built on your machine by default.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "title": "CIBW_ARCHS" - }, - "before-all": { - "description": "Execute a shell command on the build system before any wheels are built.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "title": "CIBW_BEFORE_ALL" - }, - "before-build": { - "description": "Execute a shell command preparing each wheel's build.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "title": "CIBW_BEFORE_BUILD" - }, - "before-test": { - "description": "Execute a shell command before testing each wheel.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "title": "CIBW_BEFORE_TEST" - }, - "build": { - "default": ["*"], - "description": "Choose the Python versions to build.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "title": "CIBW_BUILD" - }, - "build-frontend": { - "default": "default", - "description": "Set the tool to use to build, either \"pip\" (default for now) or \"build\"", - "oneOf": [ - { - "enum": ["pip", "build", "default"] - }, - { - "type": "string", - "pattern": "^pip; ?args:" - }, - { - "type": "string", - "pattern": "^build; ?args:" - }, - { - "type": "object", - "additionalProperties": false, - "required": ["name"], - "properties": { - "name": { - "enum": ["pip", "build"] - }, - "args": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ], - "title": "CIBW_BUILD_FRONTEND" - }, - "build-verbosity": { - "type": "integer", - "minimum": -3, - "maximum": 3, - "default": 0, - "description": "Increase/decrease the output of pip wheel.", - "title": "CIBW_BUILD_VERBOSITY" - }, - "config-settings": { - "description": "Specify config-settings for the build backend.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "additionalProperties": false, - "patternProperties": { - ".+": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - } - } - } - ], - "title": "CIBW_CONFIG_SETTINGS" - }, - "container-engine": { - "oneOf": [ - { - "enum": ["docker", "podman"] - }, - { - "type": "string", - "pattern": "^docker; ?create_args:" - }, - { - "type": "string", - "pattern": "^podman; ?create_args:" - }, - { - "type": "object", - "additionalProperties": false, - "required": ["name"], - "properties": { - "name": { - "enum": ["docker", "podman"] - }, - "create-args": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ], - "title": "CIBW_CONTAINER_ENGINE" - }, - "dependency-versions": { - "default": "pinned", - "description": "Specify how cibuildwheel controls the versions of the tools it uses", - "type": "string", - "title": "CIBW_DEPENDENCY_VERSIONS" - }, - "environment": { - "description": "Set environment variables needed during the build.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "additionalProperties": false, - "patternProperties": { - ".+": { - "type": "string" - } - } - } - ], - "title": "CIBW_ENVIRONMENT" - }, - "environment-pass": { - "description": "Set environment variables on the host to pass-through to the container during the build.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "title": "CIBW_ENVIRONMENT_PASS" - }, - "manylinux-aarch64-image": { - "type": "string", - "description": "Specify alternative manylinux / musllinux container images", - "title": "CIBW_MANYLINUX_AARCH64_IMAGE" - }, - "manylinux-i686-image": { - "type": "string", - "description": "Specify alternative manylinux / musllinux container images", - "title": "CIBW_MANYLINUX_I686_IMAGE" - }, - "manylinux-ppc64le-image": { - "type": "string", - "description": "Specify alternative manylinux / musllinux container images", - "title": "CIBW_MANYLINUX_PPC64LE_IMAGE" - }, - "manylinux-pypy_aarch64-image": { - "type": "string", - "description": "Specify alternative manylinux / musllinux container images", - "title": "CIBW_MANYLINUX_PYPY_AARCH64_IMAGE" - }, - "manylinux-pypy_i686-image": { - "type": "string", - "description": "Specify alternative manylinux / musllinux container images", - "title": "CIBW_MANYLINUX_PYPY_I686_IMAGE" - }, - "manylinux-pypy_x86_64-image": { - "type": "string", - "description": "Specify alternative manylinux / musllinux container images", - "title": "CIBW_MANYLINUX_PYPY_X86_64_IMAGE" - }, - "manylinux-s390x-image": { - "type": "string", - "description": "Specify alternative manylinux / musllinux container images", - "title": "CIBW_MANYLINUX_S390X_IMAGE" - }, - "manylinux-x86_64-image": { - "type": "string", - "description": "Specify alternative manylinux / musllinux container images", - "title": "CIBW_MANYLINUX_X86_64_IMAGE" - }, - "musllinux-aarch64-image": { - "type": "string", - "description": "Specify alternative manylinux / musllinux container images", - "title": "CIBW_MUSLLINUX_AARCH64_IMAGE" - }, - "musllinux-i686-image": { - "type": "string", - "description": "Specify alternative manylinux / musllinux container images", - "title": "CIBW_MUSLLINUX_I686_IMAGE" - }, - "musllinux-ppc64le-image": { - "type": "string", - "description": "Specify alternative manylinux / musllinux container images", - "title": "CIBW_MUSLLINUX_PPC64LE_IMAGE" - }, - "musllinux-s390x-image": { - "type": "string", - "description": "Specify alternative manylinux / musllinux container images", - "title": "CIBW_MUSLLINUX_S390X_IMAGE" - }, - "musllinux-x86_64-image": { - "type": "string", - "description": "Specify alternative manylinux / musllinux container images", - "title": "CIBW_MUSLLINUX_X86_64_IMAGE" - }, - "repair-wheel-command": { - "description": "Execute a shell command to repair each built wheel.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "title": "CIBW_REPAIR_WHEEL_COMMAND" - }, - "skip": { - "description": "Choose the Python versions to skip.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "title": "CIBW_SKIP" - }, - "test-command": { - "description": "Execute a shell command to test each built wheel.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "title": "CIBW_TEST_COMMAND" - }, - "test-extras": { - "description": "Install your wheel for testing using `extras_require`", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "title": "CIBW_TEST_EXTRAS" - }, - "test-requires": { - "description": "Install Python dependencies before running the tests", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "title": "CIBW_TEST_REQUIRES" - }, - "test-skip": { - "description": "Skip running tests on some builds.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "title": "CIBW_TEST_SKIP" - }, - "overrides": { - "type": "array", - "description": "An overrides array", - "items": { - "type": "object", - "required": ["select"], - "minProperties": 2, - "additionalProperties": false, - "properties": { - "select": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - }, - "before-all": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/before-all" - }, - "before-build": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/before-build" - }, - "before-test": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/before-test" - }, - "build-frontend": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/build-frontend" - }, - "build-verbosity": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/build-verbosity" - }, - "config-settings": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/config-settings" - }, - "dependency-versions": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/dependency-versions" - }, - "environment": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/environment" - }, - "environment-pass": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/environment-pass" - }, - "manylinux-aarch64-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/manylinux-aarch64-image" - }, - "manylinux-i686-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/manylinux-i686-image" - }, - "manylinux-ppc64le-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/manylinux-ppc64le-image" - }, - "manylinux-pypy_aarch64-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/manylinux-pypy_aarch64-image" - }, - "manylinux-pypy_i686-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/manylinux-pypy_i686-image" - }, - "manylinux-pypy_x86_64-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/manylinux-pypy_x86_64-image" - }, - "manylinux-s390x-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/manylinux-s390x-image" - }, - "manylinux-x86_64-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/manylinux-x86_64-image" - }, - "musllinux-aarch64-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/musllinux-aarch64-image" - }, - "musllinux-i686-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/musllinux-i686-image" - }, - "musllinux-ppc64le-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/musllinux-ppc64le-image" - }, - "musllinux-s390x-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/musllinux-s390x-image" - }, - "musllinux-x86_64-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/musllinux-x86_64-image" - }, - "repair-wheel-command": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/repair-wheel-command" - }, - "test-command": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/test-command" - }, - "test-extras": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/test-extras" - }, - "test-requires": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/test-requires" - } - } - } - }, - "linux": { - "type": "object", - "additionalProperties": false, - "properties": { - "archs": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/archs" - }, - "before-all": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/before-all" - }, - "before-build": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/before-build" - }, - "before-test": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/before-test" - }, - "build-frontend": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/build-frontend" - }, - "build-verbosity": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/build-verbosity" - }, - "config-settings": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/config-settings" - }, - "environment": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/environment" - }, - "environment-pass": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/environment-pass" - }, - "manylinux-aarch64-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/manylinux-aarch64-image" - }, - "manylinux-i686-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/manylinux-i686-image" - }, - "manylinux-ppc64le-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/manylinux-ppc64le-image" - }, - "manylinux-pypy_aarch64-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/manylinux-pypy_aarch64-image" - }, - "manylinux-pypy_i686-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/manylinux-pypy_i686-image" - }, - "manylinux-pypy_x86_64-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/manylinux-pypy_x86_64-image" - }, - "manylinux-s390x-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/manylinux-s390x-image" - }, - "manylinux-x86_64-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/manylinux-x86_64-image" - }, - "musllinux-aarch64-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/musllinux-aarch64-image" - }, - "musllinux-i686-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/musllinux-i686-image" - }, - "musllinux-ppc64le-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/musllinux-ppc64le-image" - }, - "musllinux-s390x-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/musllinux-s390x-image" - }, - "musllinux-x86_64-image": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/musllinux-x86_64-image" - }, - "repair-wheel-command": { - "description": "Execute a shell command to repair each built wheel.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "title": "CIBW_REPAIR_WHEEL_COMMAND", - "default": "auditwheel repair -w {dest_dir} {wheel}" - }, - "test-command": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/test-command" - }, - "test-extras": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/test-extras" - }, - "test-requires": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/test-requires" - } - } - }, - "windows": { - "type": "object", - "additionalProperties": false, - "properties": { - "archs": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/archs" - }, - "before-all": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/before-all" - }, - "before-build": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/before-build" - }, - "before-test": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/before-test" - }, - "build-frontend": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/build-frontend" - }, - "build-verbosity": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/build-verbosity" - }, - "config-settings": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/config-settings" - }, - "dependency-versions": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/dependency-versions" - }, - "environment": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/environment" - }, - "repair-wheel-command": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/repair-wheel-command" - }, - "test-command": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/test-command" - }, - "test-extras": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/test-extras" - }, - "test-requires": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/test-requires" - } - } - }, - "macos": { - "type": "object", - "additionalProperties": false, - "properties": { - "archs": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/archs" - }, - "before-all": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/before-all" - }, - "before-build": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/before-build" - }, - "before-test": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/before-test" - }, - "build-frontend": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/build-frontend" - }, - "build-verbosity": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/build-verbosity" - }, - "config-settings": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/config-settings" - }, - "dependency-versions": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/dependency-versions" - }, - "environment": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/environment" - }, - "repair-wheel-command": { - "description": "Execute a shell command to repair each built wheel.", - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "title": "CIBW_REPAIR_WHEEL_COMMAND", - "default": "delocate-wheel --require-archs {delocate_archs} -w {dest_dir} -v {wheel}" - }, - "test-command": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/test-command" - }, - "test-extras": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/test-extras" - }, - "test-requires": { - "$ref": "#/properties/tool/properties/cibuildwheel/properties/test-requires" - } - } - } - } + "$ref": "https://json.schemastore.org/partial-cibuildwheel.json" } } } diff --git a/src/schemas/json/partial-cibuildwheel.json b/src/schemas/json/partial-cibuildwheel.json new file mode 100644 index 00000000000..a4bc81ee1f6 --- /dev/null +++ b/src/schemas/json/partial-cibuildwheel.json @@ -0,0 +1,684 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "https://json.schemastore.org/partial-cibuildwheel.json", + "description": "cibuildwheel's toml file, generated with ./bin/generate_schema.py --schemastore from cibuildwheel.", + "type": "object", + "additionalProperties": false, + "properties": { + "archs": { + "description": "Change the architectures built on your machine by default.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "title": "CIBW_ARCHS" + }, + "before-all": { + "description": "Execute a shell command on the build system before any wheels are built.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "title": "CIBW_BEFORE_ALL" + }, + "before-build": { + "description": "Execute a shell command preparing each wheel's build.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "title": "CIBW_BEFORE_BUILD" + }, + "before-test": { + "description": "Execute a shell command before testing each wheel.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "title": "CIBW_BEFORE_TEST" + }, + "build": { + "default": ["*"], + "description": "Choose the Python versions to build.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "title": "CIBW_BUILD" + }, + "build-frontend": { + "default": "default", + "description": "Set the tool to use to build, either \"pip\" (default for now) or \"build\"", + "oneOf": [ + { + "enum": ["pip", "build", "default"] + }, + { + "type": "string", + "pattern": "^pip; ?args:" + }, + { + "type": "string", + "pattern": "^build; ?args:" + }, + { + "type": "object", + "additionalProperties": false, + "required": ["name"], + "properties": { + "name": { + "enum": ["pip", "build"] + }, + "args": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + ], + "title": "CIBW_BUILD_FRONTEND" + }, + "build-verbosity": { + "type": "integer", + "minimum": -3, + "maximum": 3, + "default": 0, + "description": "Increase/decrease the output of pip wheel.", + "title": "CIBW_BUILD_VERBOSITY" + }, + "config-settings": { + "description": "Specify config-settings for the build backend.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "additionalProperties": false, + "patternProperties": { + ".+": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + } + } + } + ], + "title": "CIBW_CONFIG_SETTINGS" + }, + "container-engine": { + "oneOf": [ + { + "enum": ["docker", "podman"] + }, + { + "type": "string", + "pattern": "^docker; ?create_args:" + }, + { + "type": "string", + "pattern": "^podman; ?create_args:" + }, + { + "type": "object", + "additionalProperties": false, + "required": ["name"], + "properties": { + "name": { + "enum": ["docker", "podman"] + }, + "create-args": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + ], + "title": "CIBW_CONTAINER_ENGINE" + }, + "dependency-versions": { + "default": "pinned", + "description": "Specify how cibuildwheel controls the versions of the tools it uses", + "type": "string", + "title": "CIBW_DEPENDENCY_VERSIONS" + }, + "environment": { + "description": "Set environment variables needed during the build.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "additionalProperties": false, + "patternProperties": { + ".+": { + "type": "string" + } + } + } + ], + "title": "CIBW_ENVIRONMENT" + }, + "environment-pass": { + "description": "Set environment variables on the host to pass-through to the container during the build.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "title": "CIBW_ENVIRONMENT_PASS" + }, + "manylinux-aarch64-image": { + "type": "string", + "description": "Specify alternative manylinux / musllinux container images", + "title": "CIBW_MANYLINUX_AARCH64_IMAGE" + }, + "manylinux-i686-image": { + "type": "string", + "description": "Specify alternative manylinux / musllinux container images", + "title": "CIBW_MANYLINUX_I686_IMAGE" + }, + "manylinux-ppc64le-image": { + "type": "string", + "description": "Specify alternative manylinux / musllinux container images", + "title": "CIBW_MANYLINUX_PPC64LE_IMAGE" + }, + "manylinux-pypy_aarch64-image": { + "type": "string", + "description": "Specify alternative manylinux / musllinux container images", + "title": "CIBW_MANYLINUX_PYPY_AARCH64_IMAGE" + }, + "manylinux-pypy_i686-image": { + "type": "string", + "description": "Specify alternative manylinux / musllinux container images", + "title": "CIBW_MANYLINUX_PYPY_I686_IMAGE" + }, + "manylinux-pypy_x86_64-image": { + "type": "string", + "description": "Specify alternative manylinux / musllinux container images", + "title": "CIBW_MANYLINUX_PYPY_X86_64_IMAGE" + }, + "manylinux-s390x-image": { + "type": "string", + "description": "Specify alternative manylinux / musllinux container images", + "title": "CIBW_MANYLINUX_S390X_IMAGE" + }, + "manylinux-x86_64-image": { + "type": "string", + "description": "Specify alternative manylinux / musllinux container images", + "title": "CIBW_MANYLINUX_X86_64_IMAGE" + }, + "musllinux-aarch64-image": { + "type": "string", + "description": "Specify alternative manylinux / musllinux container images", + "title": "CIBW_MUSLLINUX_AARCH64_IMAGE" + }, + "musllinux-i686-image": { + "type": "string", + "description": "Specify alternative manylinux / musllinux container images", + "title": "CIBW_MUSLLINUX_I686_IMAGE" + }, + "musllinux-ppc64le-image": { + "type": "string", + "description": "Specify alternative manylinux / musllinux container images", + "title": "CIBW_MUSLLINUX_PPC64LE_IMAGE" + }, + "musllinux-s390x-image": { + "type": "string", + "description": "Specify alternative manylinux / musllinux container images", + "title": "CIBW_MUSLLINUX_S390X_IMAGE" + }, + "musllinux-x86_64-image": { + "type": "string", + "description": "Specify alternative manylinux / musllinux container images", + "title": "CIBW_MUSLLINUX_X86_64_IMAGE" + }, + "repair-wheel-command": { + "description": "Execute a shell command to repair each built wheel.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "title": "CIBW_REPAIR_WHEEL_COMMAND" + }, + "skip": { + "description": "Choose the Python versions to skip.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "title": "CIBW_SKIP" + }, + "test-command": { + "description": "Execute a shell command to test each built wheel.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "title": "CIBW_TEST_COMMAND" + }, + "test-extras": { + "description": "Install your wheel for testing using `extras_require`", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "title": "CIBW_TEST_EXTRAS" + }, + "test-requires": { + "description": "Install Python dependencies before running the tests", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "title": "CIBW_TEST_REQUIRES" + }, + "test-skip": { + "description": "Skip running tests on some builds.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "title": "CIBW_TEST_SKIP" + }, + "overrides": { + "type": "array", + "description": "An overrides array", + "items": { + "type": "object", + "required": ["select"], + "minProperties": 2, + "additionalProperties": false, + "properties": { + "select": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + }, + "before-all": { + "$ref": "#/properties/before-all" + }, + "before-build": { + "$ref": "#/properties/before-build" + }, + "before-test": { + "$ref": "#/properties/before-test" + }, + "build-frontend": { + "$ref": "#/properties/build-frontend" + }, + "build-verbosity": { + "$ref": "#/properties/build-verbosity" + }, + "config-settings": { + "$ref": "#/properties/config-settings" + }, + "dependency-versions": { + "$ref": "#/properties/dependency-versions" + }, + "environment": { + "$ref": "#/properties/environment" + }, + "environment-pass": { + "$ref": "#/properties/environment-pass" + }, + "manylinux-aarch64-image": { + "$ref": "#/properties/manylinux-aarch64-image" + }, + "manylinux-i686-image": { + "$ref": "#/properties/manylinux-i686-image" + }, + "manylinux-ppc64le-image": { + "$ref": "#/properties/manylinux-ppc64le-image" + }, + "manylinux-pypy_aarch64-image": { + "$ref": "#/properties/manylinux-pypy_aarch64-image" + }, + "manylinux-pypy_i686-image": { + "$ref": "#/properties/manylinux-pypy_i686-image" + }, + "manylinux-pypy_x86_64-image": { + "$ref": "#/properties/manylinux-pypy_x86_64-image" + }, + "manylinux-s390x-image": { + "$ref": "#/properties/manylinux-s390x-image" + }, + "manylinux-x86_64-image": { + "$ref": "#/properties/manylinux-x86_64-image" + }, + "musllinux-aarch64-image": { + "$ref": "#/properties/musllinux-aarch64-image" + }, + "musllinux-i686-image": { + "$ref": "#/properties/musllinux-i686-image" + }, + "musllinux-ppc64le-image": { + "$ref": "#/properties/musllinux-ppc64le-image" + }, + "musllinux-s390x-image": { + "$ref": "#/properties/musllinux-s390x-image" + }, + "musllinux-x86_64-image": { + "$ref": "#/properties/musllinux-x86_64-image" + }, + "repair-wheel-command": { + "$ref": "#/properties/repair-wheel-command" + }, + "test-command": { + "$ref": "#/properties/test-command" + }, + "test-extras": { + "$ref": "#/properties/test-extras" + }, + "test-requires": { + "$ref": "#/properties/test-requires" + } + } + } + }, + "linux": { + "type": "object", + "additionalProperties": false, + "properties": { + "archs": { + "$ref": "#/properties/archs" + }, + "before-all": { + "$ref": "#/properties/before-all" + }, + "before-build": { + "$ref": "#/properties/before-build" + }, + "before-test": { + "$ref": "#/properties/before-test" + }, + "build-frontend": { + "$ref": "#/properties/build-frontend" + }, + "build-verbosity": { + "$ref": "#/properties/build-verbosity" + }, + "config-settings": { + "$ref": "#/properties/config-settings" + }, + "environment": { + "$ref": "#/properties/environment" + }, + "environment-pass": { + "$ref": "#/properties/environment-pass" + }, + "manylinux-aarch64-image": { + "$ref": "#/properties/manylinux-aarch64-image" + }, + "manylinux-i686-image": { + "$ref": "#/properties/manylinux-i686-image" + }, + "manylinux-ppc64le-image": { + "$ref": "#/properties/manylinux-ppc64le-image" + }, + "manylinux-pypy_aarch64-image": { + "$ref": "#/properties/manylinux-pypy_aarch64-image" + }, + "manylinux-pypy_i686-image": { + "$ref": "#/properties/manylinux-pypy_i686-image" + }, + "manylinux-pypy_x86_64-image": { + "$ref": "#/properties/manylinux-pypy_x86_64-image" + }, + "manylinux-s390x-image": { + "$ref": "#/properties/manylinux-s390x-image" + }, + "manylinux-x86_64-image": { + "$ref": "#/properties/manylinux-x86_64-image" + }, + "musllinux-aarch64-image": { + "$ref": "#/properties/musllinux-aarch64-image" + }, + "musllinux-i686-image": { + "$ref": "#/properties/musllinux-i686-image" + }, + "musllinux-ppc64le-image": { + "$ref": "#/properties/musllinux-ppc64le-image" + }, + "musllinux-s390x-image": { + "$ref": "#/properties/musllinux-s390x-image" + }, + "musllinux-x86_64-image": { + "$ref": "#/properties/musllinux-x86_64-image" + }, + "repair-wheel-command": { + "description": "Execute a shell command to repair each built wheel.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "title": "CIBW_REPAIR_WHEEL_COMMAND", + "default": "auditwheel repair -w {dest_dir} {wheel}" + }, + "test-command": { + "$ref": "#/properties/test-command" + }, + "test-extras": { + "$ref": "#/properties/test-extras" + }, + "test-requires": { + "$ref": "#/properties/test-requires" + } + } + }, + "windows": { + "type": "object", + "additionalProperties": false, + "properties": { + "archs": { + "$ref": "#/properties/archs" + }, + "before-all": { + "$ref": "#/properties/before-all" + }, + "before-build": { + "$ref": "#/properties/before-build" + }, + "before-test": { + "$ref": "#/properties/before-test" + }, + "build-frontend": { + "$ref": "#/properties/build-frontend" + }, + "build-verbosity": { + "$ref": "#/properties/build-verbosity" + }, + "config-settings": { + "$ref": "#/properties/config-settings" + }, + "dependency-versions": { + "$ref": "#/properties/dependency-versions" + }, + "environment": { + "$ref": "#/properties/environment" + }, + "repair-wheel-command": { + "$ref": "#/properties/repair-wheel-command" + }, + "test-command": { + "$ref": "#/properties/test-command" + }, + "test-extras": { + "$ref": "#/properties/test-extras" + }, + "test-requires": { + "$ref": "#/properties/test-requires" + } + } + }, + "macos": { + "type": "object", + "additionalProperties": false, + "properties": { + "archs": { + "$ref": "#/properties/archs" + }, + "before-all": { + "$ref": "#/properties/before-all" + }, + "before-build": { + "$ref": "#/properties/before-build" + }, + "before-test": { + "$ref": "#/properties/before-test" + }, + "build-frontend": { + "$ref": "#/properties/build-frontend" + }, + "build-verbosity": { + "$ref": "#/properties/build-verbosity" + }, + "config-settings": { + "$ref": "#/properties/config-settings" + }, + "dependency-versions": { + "$ref": "#/properties/dependency-versions" + }, + "environment": { + "$ref": "#/properties/environment" + }, + "repair-wheel-command": { + "description": "Execute a shell command to repair each built wheel.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "title": "CIBW_REPAIR_WHEEL_COMMAND", + "default": "delocate-wheel --require-archs {delocate_archs} -w {dest_dir} -v {wheel}" + }, + "test-command": { + "$ref": "#/properties/test-command" + }, + "test-extras": { + "$ref": "#/properties/test-extras" + }, + "test-requires": { + "$ref": "#/properties/test-requires" + } + } + } + } +} diff --git a/src/schemas/json/partial-poetry.json b/src/schemas/json/partial-poetry.json new file mode 100644 index 00000000000..1ee24363233 --- /dev/null +++ b/src/schemas/json/partial-poetry.json @@ -0,0 +1,639 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "https://json.schemastore.org/partial-poetry.json", + "definitions": { + "poetry-author-pattern": { + "description": "Pattern that matches `Name ` like 'King Arthur' or 'Miss Islington <miss-islington@python.org>'.", + "type": "string", + "pattern": "^(?:[- .,\\w\\d'’\"():&]+)(?: <(?:.+?)>)?" + }, + "poetry-authors": { + "type": "array", + "description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.", + "items": { + "$ref": "#/definitions/poetry-author-pattern" + } + }, + "poetry-maintainers": { + "type": "array", + "description": "List of maintainers, other than the original author(s), that upkeep the package.", + "items": { + "$ref": "#/definitions/poetry-author-pattern" + } + }, + "poetry-include-path": { + "type": "string", + "description": "Path to file or directory to include." + }, + "poetry-package-format": { + "type": "string", + "enum": ["sdist", "wheel"], + "description": "A Python packaging format." + }, + "poetry-package-formats": { + "oneOf": [ + { + "$ref": "#/definitions/poetry-package-format" + }, + { + "type": "array", + "items": { + "$ref": "#/definitions/poetry-package-format" + } + } + ], + "description": "The format(s) for which the package must be included." + }, + "poetry-dependency-any": { + "oneOf": [ + { + "$ref": "#/definitions/poetry-dependency" + }, + { + "$ref": "#/definitions/poetry-long-dependency" + }, + { + "$ref": "#/definitions/poetry-git-dependency" + }, + { + "$ref": "#/definitions/poetry-file-dependency" + }, + { + "$ref": "#/definitions/poetry-path-dependency" + }, + { + "$ref": "#/definitions/poetry-url-dependency" + }, + { + "$ref": "#/definitions/poetry-multiple-constraints-dependency" + } + ] + }, + "poetry-pep440-version": { + "type": "string", + "description": "A version constraint. Validates against the PEP 440's version pattern." + }, + "poetry-dependency": { + "$ref": "#/definitions/poetry-pep440-version" + }, + "poetry-long-dependency": { + "type": "object", + "required": ["version"], + "additionalProperties": false, + "properties": { + "version": { + "$ref": "#/definitions/poetry-pep440-version" + }, + "python": { + "type": "string", + "description": "The python versions for which the dependency should be installed." + }, + "platform": { + "type": "string", + "description": "The platform(s) for which the dependency should be installed." + }, + "markers": { + "type": "string", + "description": "The PEP 508 compliant environment markers for which the dependency should be installed." + }, + "allow-prereleases": { + "type": "boolean", + "description": "Whether the dependency allows prereleases or not." + }, + "allows-prereleases": { + "type": "boolean", + "description": "Whether the dependency allows prereleases or not." + }, + "optional": { + "type": "boolean", + "description": "Whether the dependency is optional or not." + }, + "extras": { + "type": "array", + "description": "The required extras for this dependency.", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The exclusive source used to search for this dependency." + } + } + }, + "poetry-git-dependency": { + "type": "object", + "required": ["git"], + "additionalProperties": false, + "properties": { + "git": { + "type": "string", + "description": "The url of the git repository.", + "anyOf": [ + { + "format": "uri" + }, + { + "pattern": "^([A-Za-z0-9\\-]+@|https://|http://)[A-Za-z0-9\\-]+\\.[A-Za-z0-9\\-]+(:|/)[A-Za-z0-9\\-]+/[A-Za-z0-9\\-]+\\.git$" + } + ] + }, + "branch": { + "type": "string", + "description": "The branch to checkout." + }, + "tag": { + "type": "string", + "description": "The tag to checkout." + }, + "rev": { + "type": "string", + "description": "The revision to checkout." + }, + "subdirectory": { + "type": "string", + "description": "The relative path to the directory where the package is located." + }, + "python": { + "type": "string", + "description": "The python versions for which the dependency should be installed." + }, + "platform": { + "type": "string", + "description": "The platform(s) for which the dependency should be installed." + }, + "markers": { + "type": "string", + "description": "The PEP 508 compliant environment markers for which the dependency should be installed." + }, + "allow-prereleases": { + "type": "boolean", + "description": "Whether the dependency allows prereleases or not." + }, + "allows-prereleases": { + "type": "boolean", + "description": "Whether the dependency allows prereleases or not." + }, + "optional": { + "type": "boolean", + "description": "Whether the dependency is optional or not." + }, + "extras": { + "type": "array", + "description": "The required extras for this dependency.", + "items": { + "type": "string" + } + }, + "develop": { + "type": "boolean", + "description": "Whether to install the dependency in development mode." + } + } + }, + "poetry-file-dependency": { + "type": "object", + "required": ["file"], + "additionalProperties": false, + "properties": { + "file": { + "type": "string", + "description": "The path to the file." + }, + "python": { + "type": "string", + "description": "The python versions for which the dependency should be installed." + }, + "platform": { + "type": "string", + "description": "The platform(s) for which the dependency should be installed." + }, + "markers": { + "type": "string", + "description": "The PEP 508 compliant environment markers for which the dependency should be installed." + }, + "optional": { + "type": "boolean", + "description": "Whether the dependency is optional or not." + }, + "extras": { + "type": "array", + "description": "The required extras for this dependency.", + "items": { + "type": "string" + } + } + } + }, + "poetry-path-dependency": { + "type": "object", + "required": ["path"], + "additionalProperties": false, + "properties": { + "path": { + "type": "string", + "description": "The path to the dependency." + }, + "python": { + "type": "string", + "description": "The python versions for which the dependency should be installed." + }, + "platform": { + "type": "string", + "description": "The platform(s) for which the dependency should be installed." + }, + "markers": { + "type": "string", + "description": "The PEP 508 compliant environment markers for which the dependency should be installed." + }, + "optional": { + "type": "boolean", + "description": "Whether the dependency is optional or not." + }, + "extras": { + "type": "array", + "description": "The required extras for this dependency.", + "items": { + "type": "string" + } + }, + "develop": { + "type": "boolean", + "description": "Whether to install the dependency in development mode." + } + } + }, + "poetry-url-dependency": { + "type": "object", + "required": ["url"], + "additionalProperties": false, + "properties": { + "url": { + "type": "string", + "description": "The url to the file." + }, + "python": { + "type": "string", + "description": "The python versions for which the dependency should be installed." + }, + "platform": { + "type": "string", + "description": "The platform(s) for which the dependency should be installed." + }, + "markers": { + "type": "string", + "description": "The PEP 508 compliant environment markers for which the dependency should be installed." + }, + "optional": { + "type": "boolean", + "description": "Whether the dependency is optional or not." + }, + "extras": { + "type": "array", + "description": "The required extras for this dependency.", + "items": { + "type": "string" + } + } + } + }, + "poetry-multiple-constraints-dependency": { + "type": "array", + "minItems": 1, + "items": { + "oneOf": [ + { + "$ref": "#/definitions/poetry-dependency" + }, + { + "$ref": "#/definitions/poetry-long-dependency" + }, + { + "$ref": "#/definitions/poetry-git-dependency" + }, + { + "$ref": "#/definitions/poetry-file-dependency" + }, + { + "$ref": "#/definitions/poetry-path-dependency" + }, + { + "$ref": "#/definitions/poetry-url-dependency" + } + ] + } + }, + "poetry-script-table": { + "type": "object", + "oneOf": [ + { + "$ref": "#/definitions/poetry-extra-script-legacy" + }, + { + "$ref": "#/definitions/poetry-extra-scripts" + } + ] + }, + "poetry-script-legacy": { + "type": "string", + "description": "A simple script pointing to a callable object." + }, + "poetry-extra-scripts": { + "type": "object", + "description": "Either a console entry point or a script file that'll be included in the distribution package.", + "additionalProperties": false, + "properties": { + "reference": { + "type": "string", + "description": "If type is file this is the relative path of the script file, if console it is the module name." + }, + "type": { + "description": "Value can be either file or console.", + "type": "string", + "enum": ["file", "console"] + }, + "extras": { + "type": "array", + "description": "The required extras for this script. Only applicable if type is console.", + "items": { + "type": "string" + } + } + }, + "required": ["reference", "type"] + }, + "poetry-extra-script-legacy": { + "type": "object", + "description": "A script that should be installed only if extras are activated.", + "additionalProperties": false, + "properties": { + "callable": { + "$ref": "#/definitions/poetry-script-legacy", + "description": "The entry point of the script. Deprecated in favour of reference." + }, + "extras": { + "type": "array", + "description": "The required extras for this script.", + "items": { + "type": "string" + } + } + } + }, + "poetry-build-script": { + "type": "string", + "description": "The python script file used to build extensions." + }, + "poetry-build-config": { + "type": "object", + "description": "Build specific configurations.", + "additionalProperties": false, + "properties": { + "generate-setup-file": { + "type": "boolean", + "description": "Generate and include a setup.py file in sdist.", + "default": true + }, + "script": { + "$ref": "#/definitions/poetry-build-script" + } + } + }, + "poetry-build-section": { + "oneOf": [ + { + "$ref": "#/definitions/poetry-build-script" + }, + { + "$ref": "#/definitions/poetry-build-config" + } + ] + } + }, + "type": "object", + "additionalProperties": true, + "required": ["name", "version", "description", "authors"], + "properties": { + "name": { + "type": "string", + "description": "Package name." + }, + "version": { + "type": "string", + "description": "Version of the package. It should follow semantic versioning, but it is not enforced." + }, + "description": { + "type": "string", + "description": "Short package description.", + "pattern": "^[^\n]*$" + }, + "keywords": { + "type": "array", + "items": { + "type": "string", + "description": "A tag/keyword that this package relates to." + } + }, + "homepage": { + "type": "string", + "description": "Homepage URL for the project.", + "format": "uri" + }, + "repository": { + "type": "string", + "description": "Repository URL for the project.", + "format": "uri" + }, + "documentation": { + "type": "string", + "description": "Documentation URL for the project.", + "format": "uri" + }, + "license": { + "type": "string", + "description": "License name." + }, + "authors": { + "$ref": "#/definitions/poetry-authors" + }, + "maintainers": { + "$ref": "#/definitions/poetry-maintainers" + }, + "readme": { + "anyOf": [ + { + "type": "string", + "description": "The path to the README file." + }, + { + "type": "array", + "description": "A list of paths to the readme files.", + "items": { + "type": "string" + } + } + ] + }, + "classifiers": { + "type": "array", + "description": "A list of trove classifiers." + }, + "packages": { + "type": "array", + "description": "A list of packages to include in the final distribution.", + "items": { + "type": "object", + "description": "Information about where the package resides.", + "additionalProperties": false, + "required": ["include"], + "properties": { + "include": { + "$ref": "#/definitions/poetry-include-path" + }, + "from": { + "type": "string", + "description": "Where the source directory of the package resides." + }, + "format": { + "$ref": "#/definitions/poetry-package-formats" + } + } + } + }, + "include": { + "type": "array", + "description": "A list of files and folders to include.", + "items": { + "anyOf": [ + { + "$ref": "#/definitions/poetry-include-path" + }, + { + "type": "object", + "additionalProperties": false, + "required": ["path"], + "properties": { + "path": { + "$ref": "#/definitions/poetry-include-path" + }, + "format": { + "$ref": "#/definitions/poetry-package-formats" + } + } + } + ] + } + }, + "exclude": { + "type": "array", + "description": "A list of files and folders to exclude." + }, + "dependencies": { + "type": "object", + "description": "This is a hash of package name (keys) and version constraints (values) that are required to run this package.", + "required": ["python"], + "properties": { + "python": { + "$ref": "#/definitions/poetry-dependency", + "type": "string", + "description": "The Python versions the package is compatible with." + } + }, + "patternProperties": { + "^(?!python$)[a-zA-Z-_.0-9]+$": { + "$ref": "#/definitions/poetry-dependency-any" + } + } + }, + "dev-dependencies": { + "type": "object", + "description": "This is a hash of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).", + "patternProperties": { + "^[a-zA-Z-_.0-9]+$": { + "$ref": "#/definitions/poetry-dependency-any" + } + } + }, + "extras": { + "type": "object", + "patternProperties": { + "^[a-zA-Z-_.0-9]+$": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "group": { + "type": "object", + "description": "This represents groups of dependencies", + "patternProperties": { + "^[a-zA-Z-_.0-9]+$": { + "type": "object", + "description": "This represents a single dependency group", + "required": ["dependencies"], + "properties": { + "optional": { + "type": "boolean", + "description": "Whether the dependency group is optional or not" + }, + "dependencies": { + "type": "object", + "description": "The dependencies of this dependency group", + "patternProperties": { + "^[a-zA-Z-_.0-9]+$": { + "$ref": "#/definitions/poetry-dependency-any" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false + } + } + }, + "build": { + "$ref": "#/definitions/poetry-build-section" + }, + "scripts": { + "type": "object", + "description": "A hash of scripts to be installed.", + "patternProperties": { + "^[a-zA-Z-_.0-9]+$": { + "oneOf": [ + { + "$ref": "#/definitions/poetry-script-legacy" + }, + { + "$ref": "#/definitions/poetry-script-table" + } + ] + } + } + }, + "plugins": { + "type": "object", + "description": "A hash of hashes representing plugins", + "patternProperties": { + "^[a-zA-Z-_.0-9]+$": { + "type": "object", + "patternProperties": { + "^[a-zA-Z-_.0-9]+$": { + "type": "string" + } + } + } + } + }, + "urls": { + "type": "object", + "patternProperties": { + "^.+$": { + "type": "string", + "description": "The full url of the custom url." + } + } + } + } +} diff --git a/src/schemas/json/partial-scikit-build.json b/src/schemas/json/partial-scikit-build.json new file mode 100644 index 00000000000..b732f6a7c0c --- /dev/null +++ b/src/schemas/json/partial-scikit-build.json @@ -0,0 +1,469 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "https://json.schemastore.org/partial-scikit-build.json", + "$defs": { + "metadata": { + "type": "object", + "properties": { + "provider": { + "type": "string" + }, + "provider-path": { + "type": "string" + } + } + }, + "if_overrides": { + "type": "object", + "minProperties": 1, + "additionalProperties": false, + "properties": { + "python-version": { + "type": "string" + }, + "implementation-name": { + "type": "string" + }, + "implementation-version": { + "type": "string" + }, + "platform-system": { + "type": "string" + }, + "platform-machine": { + "type": "string" + }, + "platform-node": { + "type": "string" + }, + "env": { + "type": "object", + "patternProperties": { + ".*": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + }, + "additionalProperties": false, + "minProperties": 1 + } + } + } + }, + "description": "Scikit-build-core's settings.", + "type": "object", + "additionalProperties": false, + "properties": { + "cmake": { + "type": "object", + "additionalProperties": false, + "properties": { + "minimum-version": { + "type": "string", + "default": "3.15", + "description": "The minimum version of CMake to use. If CMake is not present on the system or is older than this, it will be downloaded via PyPI if possible. An empty string will disable this check." + }, + "args": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of args to pass to CMake when configuring the project. Setting this in config or envvar will override toml. See also ``cmake.define``." + }, + "define": { + "type": "object", + "patternProperties": { + ".+": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "boolean" + } + ] + } + }, + "description": "A table of defines to pass to CMake when configuring the project. Additive." + }, + "verbose": { + "type": "boolean", + "default": false, + "description": "Verbose printout when building." + }, + "build-type": { + "type": "string", + "default": "Release", + "description": "The build type to use when building the project. Valid options are: \"Debug\", \"Release\", \"RelWithDebInfo\", \"MinSizeRel\", \"\", etc." + }, + "source-dir": { + "type": "string", + "default": ".", + "description": "The source directory to use when building the project. Currently only affects the native builder (not the setuptools plugin)." + }, + "targets": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The build targets to use when building the project. Empty builds the default target." + } + } + }, + "ninja": { + "type": "object", + "additionalProperties": false, + "properties": { + "minimum-version": { + "type": "string", + "default": "1.5", + "description": "The minimum version of Ninja to use. If Ninja is not present on the system or is older than this, it will be downloaded via PyPI if possible. An empty string will disable this check." + }, + "make-fallback": { + "type": "boolean", + "default": true, + "description": "If CMake is not present on the system or is older required, it will be downloaded via PyPI if possible. An empty string will disable this check." + } + } + }, + "logging": { + "type": "object", + "additionalProperties": false, + "properties": { + "level": { + "enum": ["NOTSET", "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"], + "default": "WARNING", + "description": "The logging level to display, \"DEBUG\", \"INFO\", \"WARNING\", and \"ERROR\" are possible options." + } + } + }, + "sdist": { + "type": "object", + "additionalProperties": false, + "properties": { + "include": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Files to include in the SDist even if they are skipped by default. Supports gitignore syntax." + }, + "exclude": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Files to exclude from the SDist even if they are included by default. Supports gitignore syntax." + }, + "reproducible": { + "type": "boolean", + "default": true, + "description": "If set to True, try to build a reproducible distribution (Unix and Python 3.9+ recommended). ``SOURCE_DATE_EPOCH`` will be used for timestamps, or a fixed value if not set." + }, + "cmake": { + "type": "boolean", + "default": false, + "description": "If set to True, CMake will be run before building the SDist." + } + } + }, + "wheel": { + "type": "object", + "additionalProperties": false, + "properties": { + "packages": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of packages to auto-copy into the wheel. If this is not set, it will default to the first of ``src/``, ``python/``, or ```` if they exist. The prefix(s) will be stripped from the package name inside the wheel." + }, + "py-api": { + "type": "string", + "default": "", + "description": "The Python tags. The default (empty string) will use the default Python version. You can also set this to \"cp37\" to enable the CPython 3.7+ Stable ABI / Limited API (only on CPython and if the version is sufficient, otherwise this has no effect). Or you can set it to \"py3\" or \"py2.py3\" to ignore Python ABI compatibility. The ABI tag is inferred from this tag." + }, + "expand-macos-universal-tags": { + "type": "boolean", + "default": false, + "description": "Fill out extra tags that are not required. This adds \"x86_64\" and \"arm64\" to the list of platforms when \"universal2\" is used, which helps older Pip's (before 21.0.1) find the correct wheel." + }, + "install-dir": { + "type": "string", + "default": "", + "description": "The install directory for the wheel. This is relative to the platlib root. You might set this to the package name. The original dir is still at SKBUILD_PLATLIB_DIR (also SKBUILD_DATA_DIR, etc. are available). EXPERIMENTAL: An absolute path will be one level higher than the platlib root, giving access to \"/platlib\", \"/data\", \"/headers\", and \"/scripts\"." + }, + "license-files": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of license files to include in the wheel. Supports glob patterns." + }, + "cmake": { + "type": "boolean", + "default": true, + "description": "If set to True (the default), CMake will be run before building the wheel." + }, + "platlib": { + "type": "boolean", + "description": "Target the platlib or the purelib. If not set, the default is to target the platlib if wheel.cmake is true, and the purelib otherwise." + }, + "exclude": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A set of patterns to exclude from the wheel. This is additive to the SDist exclude patterns. This applies to the source files, not the final paths. Editable installs may not respect this exclusion." + } + } + }, + "backport": { + "type": "object", + "additionalProperties": false, + "properties": { + "find-python": { + "type": "string", + "default": "3.26.1", + "description": "If CMake is less than this value, backport a copy of FindPython. Set to 0 disable this, or the empty string." + } + } + }, + "editable": { + "type": "object", + "additionalProperties": false, + "properties": { + "mode": { + "enum": ["redirect", "inplace"], + "default": "redirect", + "description": "Select the editable mode to use. Can be \"redirect\" (default) or \"inplace\"." + }, + "verbose": { + "type": "boolean", + "default": true, + "description": "Turn on verbose output for the editable mode rebuilds." + }, + "rebuild": { + "type": "boolean", + "default": false, + "description": "Rebuild the project when the package is imported. The build-directory must be set." + } + } + }, + "install": { + "type": "object", + "additionalProperties": false, + "properties": { + "components": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The components to install. If empty, all default components are installed." + }, + "strip": { + "type": "boolean", + "description": "Whether to strip the binaries. True for scikit-build-core 0.5+." + } + } + }, + "generate": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "object", + "additionalProperties": false, + "required": ["path", "template"], + "properties": { + "path": { + "type": "string", + "description": "The path (relative to platlib) for the file to generate.", + "minLength": 1 + }, + "template": { + "type": "string", + "description": "The template to use for the file. This includes string.Template style placeholders for all the metadata. If empty, a template-path must be set.", + "minLength": 1 + }, + "location": { + "enum": ["install", "build", "source"], + "default": "install", + "description": "The place to put the generated file. The \"build\" directory is useful for CMake files, and the \"install\" directory is useful for Python files, usually. You can also write directly to the \"source\" directory, will overwrite existing files & remember to gitignore the file." + } + } + }, + { + "type": "object", + "additionalProperties": false, + "required": ["path", "template-path"], + "properties": { + "path": { + "type": "string", + "description": "The path (relative to platlib) for the file to generate.", + "minLength": 1 + }, + "template-path": { + "type": "string", + "description": "The path to the template file. If empty, a template must be set.", + "minLength": 1 + }, + "location": { + "enum": ["install", "build", "source"], + "default": "install", + "description": "The place to put the generated file. The \"build\" directory is useful for CMake files, and the \"install\" directory is useful for Python files, usually. You can also write directly to the \"source\" directory, will overwrite existing files & remember to gitignore the file." + } + } + } + ] + } + }, + "metadata": { + "type": "object", + "description": "List dynamic metadata fields and hook locations in this table.", + "additionalProperties": false, + "properties": { + "version": { + "$ref": "#/$defs/metadata" + }, + "description": { + "$ref": "#/$defs/metadata" + }, + "license": { + "$ref": "#/$defs/metadata" + }, + "readme": { + "$ref": "#/$defs/metadata" + }, + "requires-python": { + "$ref": "#/$defs/metadata" + }, + "dependencies": { + "$ref": "#/$defs/metadata" + }, + "optional-dependencies": { + "$ref": "#/$defs/metadata" + }, + "entrypoints": { + "$ref": "#/$defs/metadata" + }, + "authors": { + "$ref": "#/$defs/metadata" + }, + "maintainers": { + "$ref": "#/$defs/metadata" + }, + "urls": { + "$ref": "#/$defs/metadata" + }, + "classifiers": { + "$ref": "#/$defs/metadata" + }, + "keywords": { + "$ref": "#/$defs/metadata" + }, + "scripts": { + "$ref": "#/$defs/metadata" + }, + "gui-scripts": { + "$ref": "#/$defs/metadata" + } + } + }, + "strict-config": { + "type": "boolean", + "default": true, + "description": "Strictly check all config options. If False, warnings will be printed for unknown options. If True, an error will be raised." + }, + "experimental": { + "type": "boolean", + "default": false, + "description": "Enable early previews of features not finalized yet." + }, + "minimum-version": { + "type": "string", + "description": "If set, this will provide a method for backward compatibility." + }, + "build-dir": { + "type": "string", + "default": "", + "description": "The build directory. Defaults to a temporary directory, but can be set." + }, + "overrides": { + "type": "array", + "items": { + "type": "object", + "required": ["if"], + "minProperties": 2, + "additionalProperties": false, + "properties": { + "if": { + "anyOf": [ + { + "$ref": "#/$defs/if_overrides" + }, + { + "type": "object", + "properties": { + "any": { + "$ref": "#/$defs/if_overrides" + } + }, + "required": ["any"], + "additionalProperties": false + } + ] + }, + "cmake": { + "$ref": "#/properties/cmake" + }, + "ninja": { + "$ref": "#/properties/ninja" + }, + "logging": { + "$ref": "#/properties/logging" + }, + "sdist": { + "$ref": "#/properties/sdist" + }, + "wheel": { + "$ref": "#/properties/wheel" + }, + "backport": { + "$ref": "#/properties/backport" + }, + "editable": { + "$ref": "#/properties/editable" + }, + "install": { + "$ref": "#/properties/install" + }, + "generate": { + "$ref": "#/properties/generate" + }, + "metadata": { + "$ref": "#/properties/metadata" + }, + "strict-config": { + "$ref": "#/properties/strict-config" + }, + "experimental": { + "$ref": "#/properties/experimental" + }, + "minimum-version": { + "$ref": "#/properties/minimum-version" + }, + "build-dir": { + "$ref": "#/properties/build-dir" + } + } + } + } + } +} diff --git a/src/schemas/json/partial-setuptools.json b/src/schemas/json/partial-setuptools.json new file mode 100644 index 00000000000..6530021d398 --- /dev/null +++ b/src/schemas/json/partial-setuptools.json @@ -0,0 +1,352 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "https://json.schemastore.org/partial-setuptools.json", + "title": "``tool.setuptools`` table", + "type": "object", + "additionalProperties": false, + "properties": { + "platforms": { + "type": "array", + "items": { + "type": "string" + } + }, + "provides": { + "type": "array", + "items": { + "type": "string", + "format": "pep508-identifier" + }, + "description": "Package and virtual package names contained within this package **(not supported by pip)**" + }, + "obsoletes": { + "type": "array", + "items": { + "type": "string", + "format": "pep508-identifier" + }, + "description": "Packages which this package renders obsolete **(not supported by pip)**" + }, + "zip-safe": { + "type": "boolean", + "description": "Whether the project can be safely installed and run from a zip file. **OBSOLETE**: only relevant for ``pkg_resources``, ``easy_install`` and ``setup.py install`` in the context of ``eggs`` (**DEPRECATED**)." + }, + "script-files": { + "$comment": "TODO: is this field deprecated/should be removed?", + "type": "array", + "items": { + "type": "string" + }, + "description": "Legacy way of defining scripts (entry-points are preferred). Equivalent to the ``script`` keyword in ``setup.py`` (it was renamed to avoid confusion with entry-point based ``project.scripts`` defined in :pep:`621`). **DISCOURAGED**: generic script wrappers are tricky and may not work properly. Whenever possible, please use ``project.scripts`` instead." + }, + "eager-resources": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Resources that should be extracted together, if any of them is needed, or if any C extensions included in the project are imported. **OBSOLETE**: only relevant for ``pkg_resources``, ``easy_install`` and ``setup.py install`` in the context of ``eggs`` (**DEPRECATED**)." + }, + "packages": { + "oneOf": [ + { + "title": "Array of Python package identifiers", + "type": "array", + "items": { + "$ref": "#/definitions/package-name" + } + }, + { + "$ref": "#/definitions/find-directive" + } + ], + "description": "Packages that should be included in the distribution. It can be given either as a list of package identifiers or as a ``dict``-like structure with a single key ``find`` which corresponds to a dynamic call to ``setuptools.config.expand.find_packages`` function. The ``find`` key is associated with a nested ``dict``-like structure that can contain ``where``, ``include``, ``exclude`` and ``namespaces`` keys, mimicking the keyword arguments of the associated function." + }, + "package-dir": { + "type": "object", + "additionalProperties": false, + "propertyNames": { + "anyOf": [ + { + "const": "" + }, + { + "$ref": "#/definitions/package-name" + } + ] + }, + "patternProperties": { + "^.*$": { + "type": "string" + } + }, + "description": ":class:`dict`-like structure mapping from package names to directories where their code can be found. The empty string (as key) means that all packages are contained inside the given directory will be included in the distribution." + }, + "package-data": { + "type": "object", + "additionalProperties": false, + "propertyNames": { + "anyOf": [ + { + "type": "string", + "format": "python-module-name" + }, + { + "const": "*" + } + ] + }, + "patternProperties": { + "^.*$": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "description": "Mapping from package names to lists of glob patterns. Usually this option is not needed when using ``include-package-data = true`` For more information on how to include data files, check ``setuptools`` `docs `_." + }, + "include-package-data": { + "type": "boolean", + "description": "Automatically include any data files inside the package directories that are specified by ``MANIFEST.in`` For more information on how to include data files, check ``setuptools`` `docs `_." + }, + "exclude-package-data": { + "type": "object", + "additionalProperties": false, + "propertyNames": { + "anyOf": [ + { + "type": "string", + "format": "python-module-name" + }, + { + "const": "*" + } + ] + }, + "patternProperties": { + "^.*$": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "description": "Mapping from package names to lists of glob patterns that should be excluded For more information on how to include data files, check ``setuptools`` `docs `_." + }, + "namespace-packages": { + "$comment": "https://setuptools.pypa.io/en/latest/userguide/package_discovery.html", + "type": "array", + "items": { + "type": "string", + "format": "python-module-name" + }, + "description": "**DEPRECATED**: use implicit namespaces instead (:pep:`420`)." + }, + "py-modules": { + "$comment": "TODO: clarify the relationship with ``packages``", + "description": "Modules that setuptools will manipulate", + "type": "array", + "items": { + "type": "string", + "format": "python-module-name" + } + }, + "data-files": { + "type": "object", + "patternProperties": { + "^.*$": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "description": "``dict``-like structure where each key represents a directory and the value is a list of glob patterns that should be installed in them. **DISCOURAGED**: please notice this might not work as expected with wheels. Whenever possible, consider using data files inside the package directories (or create a new namespace package that only contains data files). See `data files support `_." + }, + "cmdclass": { + "type": "object", + "patternProperties": { + "^.*$": { + "type": "string", + "format": "python-qualified-identifier" + } + }, + "description": "Mapping of distutils-style command names to ``setuptools.Command`` subclasses which in turn should be represented by strings with a qualified class name (i.e., \"dotted\" form with module), e.g.::\n\n cmdclass = {mycmd = \"pkg.subpkg.module.CommandClass\"}\n\n The command class should be a directly defined at the top-level of the containing module (no class nesting)." + }, + "license-files": { + "$comment": "TODO: revise if PEP 639 is accepted. Probably ``project.license-files``?", + "type": "array", + "items": { + "type": "string" + }, + "description": "**PROVISIONAL**: list of glob patterns for all license files being distributed. (likely to become standard with :pep:`639`). By default: ``['LICEN[CS]E*', 'COPYING*', 'NOTICE*', 'AUTHORS*']``" + }, + "dynamic": { + "type": "object", + "description": "Instructions for loading :pep:`621`-related metadata dynamically", + "additionalProperties": false, + "properties": { + "version": { + "oneOf": [ + { + "$ref": "#/definitions/attr-directive" + }, + { + "$ref": "#/definitions/file-directive" + } + ], + "description": "A version dynamically loaded via either the ``attr:`` or ``file:`` directives. Please make sure the given file or attribute respects :pep:`440`. Also ensure to set ``project.dynamic`` accordingly." + }, + "classifiers": { + "$ref": "#/definitions/file-directive" + }, + "description": { + "$ref": "#/definitions/file-directive" + }, + "entry-points": { + "$ref": "#/definitions/file-directive" + }, + "dependencies": { + "$ref": "#/definitions/file-directive-for-dependencies" + }, + "optional-dependencies": { + "type": "object", + "propertyNames": { + "type": "string", + "format": "python-identifier" + }, + "additionalProperties": false, + "patternProperties": { + ".+": { + "$ref": "#/definitions/file-directive-for-dependencies" + } + } + }, + "readme": { + "type": "object", + "anyOf": [ + { + "$ref": "#/definitions/file-directive" + }, + { + "type": "object", + "properties": { + "content-type": { + "type": "string" + }, + "file": { + "$ref": "#/definitions/file-directive/properties/file" + } + }, + "additionalProperties": false + } + ], + "required": ["file"] + } + } + } + }, + "definitions": { + "package-name": { + "title": "Valid package name", + "description": "Valid package name (importable or :pep:`561`).", + "type": "string", + "anyOf": [ + { + "type": "string", + "format": "python-module-name" + }, + { + "type": "string", + "format": "pep561-stub-name" + } + ] + }, + "file-directive": { + "title": "'file:' directive", + "description": "Value is read from a file (or list of files and then concatenated)", + "type": "object", + "additionalProperties": false, + "properties": { + "file": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + } + }, + "required": ["file"] + }, + "file-directive-for-dependencies": { + "title": "'file:' directive for dependencies", + "allOf": [ + { + "description": "**BETA**: subset of the ``requirements.txt`` format without ``pip`` flags and options (one :pep:`508`-compliant string per line, lines that are blank or start with ``#`` are excluded). See `dynamic metadata `_." + }, + { + "$ref": "#/definitions/file-directive" + } + ] + }, + "attr-directive": { + "title": "'attr:' directive", + "type": "object", + "additionalProperties": false, + "properties": { + "attr": { + "type": "string", + "format": "python-qualified-identifier" + } + }, + "required": ["attr"], + "description": "Value is read from a module attribute. Supports callables and iterables; unsupported types are cast via ``str()``" + }, + "find-directive": { + "title": "'find:' directive", + "type": "object", + "additionalProperties": false, + "properties": { + "find": { + "type": "object", + "additionalProperties": false, + "properties": { + "where": { + "description": "Directories to be searched for packages (Unix-style relative path)", + "type": "array", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Exclude packages that match the values listed in this field. Can container shell-style wildcards (e.g. ``'pkg.*'``)" + }, + "include": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Restrict the found packages to just the ones listed in this field. Can container shell-style wildcards (e.g. ``'pkg.*'``)" + }, + "namespaces": { + "type": "boolean", + "description": "When ``True``, directories without a ``__init__.py`` file will also be scanned for :pep:`420`-style implicit namespaces" + } + }, + "description": "Dynamic `package discovery `_." + } + } + } + }, + "description": "``setuptools``-specific configurations that can be set by users that require customization. These configurations are completely optional and probably can be skipped when creating simple packages. They are equivalent to some of the `Keywords `_ used by the ``setup.py`` file, and can be set via the ``tool.setuptools`` table. It considers only ``setuptools`` `parameters `_ that are not covered by :pep:`621`; and intentionally excludes ``dependency_links`` and ``setup_requires`` (incompatible with modern workflows/standards)." +} diff --git a/src/schemas/json/poetry.json b/src/schemas/json/poetry.json index 5cb41317549..e1e55880aa0 100644 --- a/src/schemas/json/poetry.json +++ b/src/schemas/json/poetry.json @@ -1,639 +1,5 @@ { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://json.schemastore.org/poetry.json", - "definitions": { - "poetry-author-pattern": { - "description": "Pattern that matches `Name ` like 'King Arthur' or 'Miss Islington <miss-islington@python.org>'.", - "type": "string", - "pattern": "^(?:[- .,\\w\\d'’\"():&]+)(?: <(?:.+?)>)?" - }, - "poetry-authors": { - "type": "array", - "description": "List of authors that contributed to the package. This is typically the main maintainers, not the full list.", - "items": { - "$ref": "#/definitions/poetry-author-pattern" - } - }, - "poetry-maintainers": { - "type": "array", - "description": "List of maintainers, other than the original author(s), that upkeep the package.", - "items": { - "$ref": "#/definitions/poetry-author-pattern" - } - }, - "poetry-include-path": { - "type": "string", - "description": "Path to file or directory to include." - }, - "poetry-package-format": { - "type": "string", - "enum": ["sdist", "wheel"], - "description": "A Python packaging format." - }, - "poetry-package-formats": { - "oneOf": [ - { - "$ref": "#/definitions/poetry-package-format" - }, - { - "type": "array", - "items": { - "$ref": "#/definitions/poetry-package-format" - } - } - ], - "description": "The format(s) for which the package must be included." - }, - "poetry-dependency-any": { - "oneOf": [ - { - "$ref": "#/definitions/poetry-dependency" - }, - { - "$ref": "#/definitions/poetry-long-dependency" - }, - { - "$ref": "#/definitions/poetry-git-dependency" - }, - { - "$ref": "#/definitions/poetry-file-dependency" - }, - { - "$ref": "#/definitions/poetry-path-dependency" - }, - { - "$ref": "#/definitions/poetry-url-dependency" - }, - { - "$ref": "#/definitions/poetry-multiple-constraints-dependency" - } - ] - }, - "poetry-pep440-version": { - "type": "string", - "description": "A version constraint. Validates against the PEP 440's version pattern." - }, - "poetry-dependency": { - "$ref": "#/definitions/poetry-pep440-version" - }, - "poetry-long-dependency": { - "type": "object", - "required": ["version"], - "additionalProperties": false, - "properties": { - "version": { - "$ref": "#/definitions/poetry-pep440-version" - }, - "python": { - "type": "string", - "description": "The python versions for which the dependency should be installed." - }, - "platform": { - "type": "string", - "description": "The platform(s) for which the dependency should be installed." - }, - "markers": { - "type": "string", - "description": "The PEP 508 compliant environment markers for which the dependency should be installed." - }, - "allow-prereleases": { - "type": "boolean", - "description": "Whether the dependency allows prereleases or not." - }, - "allows-prereleases": { - "type": "boolean", - "description": "Whether the dependency allows prereleases or not." - }, - "optional": { - "type": "boolean", - "description": "Whether the dependency is optional or not." - }, - "extras": { - "type": "array", - "description": "The required extras for this dependency.", - "items": { - "type": "string" - } - }, - "source": { - "type": "string", - "description": "The exclusive source used to search for this dependency." - } - } - }, - "poetry-git-dependency": { - "type": "object", - "required": ["git"], - "additionalProperties": false, - "properties": { - "git": { - "type": "string", - "description": "The url of the git repository.", - "anyOf": [ - { - "format": "uri" - }, - { - "pattern": "^([A-Za-z0-9\\-]+@|https://|http://)[A-Za-z0-9\\-]+\\.[A-Za-z0-9\\-]+(:|/)[A-Za-z0-9\\-]+/[A-Za-z0-9\\-]+\\.git$" - } - ] - }, - "branch": { - "type": "string", - "description": "The branch to checkout." - }, - "tag": { - "type": "string", - "description": "The tag to checkout." - }, - "rev": { - "type": "string", - "description": "The revision to checkout." - }, - "subdirectory": { - "type": "string", - "description": "The relative path to the directory where the package is located." - }, - "python": { - "type": "string", - "description": "The python versions for which the dependency should be installed." - }, - "platform": { - "type": "string", - "description": "The platform(s) for which the dependency should be installed." - }, - "markers": { - "type": "string", - "description": "The PEP 508 compliant environment markers for which the dependency should be installed." - }, - "allow-prereleases": { - "type": "boolean", - "description": "Whether the dependency allows prereleases or not." - }, - "allows-prereleases": { - "type": "boolean", - "description": "Whether the dependency allows prereleases or not." - }, - "optional": { - "type": "boolean", - "description": "Whether the dependency is optional or not." - }, - "extras": { - "type": "array", - "description": "The required extras for this dependency.", - "items": { - "type": "string" - } - }, - "develop": { - "type": "boolean", - "description": "Whether to install the dependency in development mode." - } - } - }, - "poetry-file-dependency": { - "type": "object", - "required": ["file"], - "additionalProperties": false, - "properties": { - "file": { - "type": "string", - "description": "The path to the file." - }, - "python": { - "type": "string", - "description": "The python versions for which the dependency should be installed." - }, - "platform": { - "type": "string", - "description": "The platform(s) for which the dependency should be installed." - }, - "markers": { - "type": "string", - "description": "The PEP 508 compliant environment markers for which the dependency should be installed." - }, - "optional": { - "type": "boolean", - "description": "Whether the dependency is optional or not." - }, - "extras": { - "type": "array", - "description": "The required extras for this dependency.", - "items": { - "type": "string" - } - } - } - }, - "poetry-path-dependency": { - "type": "object", - "required": ["path"], - "additionalProperties": false, - "properties": { - "path": { - "type": "string", - "description": "The path to the dependency." - }, - "python": { - "type": "string", - "description": "The python versions for which the dependency should be installed." - }, - "platform": { - "type": "string", - "description": "The platform(s) for which the dependency should be installed." - }, - "markers": { - "type": "string", - "description": "The PEP 508 compliant environment markers for which the dependency should be installed." - }, - "optional": { - "type": "boolean", - "description": "Whether the dependency is optional or not." - }, - "extras": { - "type": "array", - "description": "The required extras for this dependency.", - "items": { - "type": "string" - } - }, - "develop": { - "type": "boolean", - "description": "Whether to install the dependency in development mode." - } - } - }, - "poetry-url-dependency": { - "type": "object", - "required": ["url"], - "additionalProperties": false, - "properties": { - "url": { - "type": "string", - "description": "The url to the file." - }, - "python": { - "type": "string", - "description": "The python versions for which the dependency should be installed." - }, - "platform": { - "type": "string", - "description": "The platform(s) for which the dependency should be installed." - }, - "markers": { - "type": "string", - "description": "The PEP 508 compliant environment markers for which the dependency should be installed." - }, - "optional": { - "type": "boolean", - "description": "Whether the dependency is optional or not." - }, - "extras": { - "type": "array", - "description": "The required extras for this dependency.", - "items": { - "type": "string" - } - } - } - }, - "poetry-multiple-constraints-dependency": { - "type": "array", - "minItems": 1, - "items": { - "oneOf": [ - { - "$ref": "#/definitions/poetry-dependency" - }, - { - "$ref": "#/definitions/poetry-long-dependency" - }, - { - "$ref": "#/definitions/poetry-git-dependency" - }, - { - "$ref": "#/definitions/poetry-file-dependency" - }, - { - "$ref": "#/definitions/poetry-path-dependency" - }, - { - "$ref": "#/definitions/poetry-url-dependency" - } - ] - } - }, - "poetry-script-table": { - "type": "object", - "oneOf": [ - { - "$ref": "#/definitions/poetry-extra-script-legacy" - }, - { - "$ref": "#/definitions/poetry-extra-scripts" - } - ] - }, - "poetry-script-legacy": { - "type": "string", - "description": "A simple script pointing to a callable object." - }, - "poetry-extra-scripts": { - "type": "object", - "description": "Either a console entry point or a script file that'll be included in the distribution package.", - "additionalProperties": false, - "properties": { - "reference": { - "type": "string", - "description": "If type is file this is the relative path of the script file, if console it is the module name." - }, - "type": { - "description": "Value can be either file or console.", - "type": "string", - "enum": ["file", "console"] - }, - "extras": { - "type": "array", - "description": "The required extras for this script. Only applicable if type is console.", - "items": { - "type": "string" - } - } - }, - "required": ["reference", "type"] - }, - "poetry-extra-script-legacy": { - "type": "object", - "description": "A script that should be installed only if extras are activated.", - "additionalProperties": false, - "properties": { - "callable": { - "$ref": "#/definitions/poetry-script-legacy", - "description": "The entry point of the script. Deprecated in favour of reference." - }, - "extras": { - "type": "array", - "description": "The required extras for this script.", - "items": { - "type": "string" - } - } - } - }, - "poetry-build-script": { - "type": "string", - "description": "The python script file used to build extensions." - }, - "poetry-build-config": { - "type": "object", - "description": "Build specific configurations.", - "additionalProperties": false, - "properties": { - "generate-setup-file": { - "type": "boolean", - "description": "Generate and include a setup.py file in sdist.", - "default": true - }, - "script": { - "$ref": "#/definitions/poetry-build-script" - } - } - }, - "poetry-build-section": { - "oneOf": [ - { - "$ref": "#/definitions/poetry-build-script" - }, - { - "$ref": "#/definitions/poetry-build-config" - } - ] - } - }, - "type": "object", - "additionalProperties": true, - "required": ["name", "version", "description", "authors"], - "properties": { - "name": { - "type": "string", - "description": "Package name." - }, - "version": { - "type": "string", - "description": "Version of the package. It should follow semantic versioning, but it is not enforced." - }, - "description": { - "type": "string", - "description": "Short package description.", - "pattern": "^[^\n]*$" - }, - "keywords": { - "type": "array", - "items": { - "type": "string", - "description": "A tag/keyword that this package relates to." - } - }, - "homepage": { - "type": "string", - "description": "Homepage URL for the project.", - "format": "uri" - }, - "repository": { - "type": "string", - "description": "Repository URL for the project.", - "format": "uri" - }, - "documentation": { - "type": "string", - "description": "Documentation URL for the project.", - "format": "uri" - }, - "license": { - "type": "string", - "description": "License name." - }, - "authors": { - "$ref": "#/definitions/poetry-authors" - }, - "maintainers": { - "$ref": "#/definitions/poetry-maintainers" - }, - "readme": { - "anyOf": [ - { - "type": "string", - "description": "The path to the README file." - }, - { - "type": "array", - "description": "A list of paths to the readme files.", - "items": { - "type": "string" - } - } - ] - }, - "classifiers": { - "type": "array", - "description": "A list of trove classifiers." - }, - "packages": { - "type": "array", - "description": "A list of packages to include in the final distribution.", - "items": { - "type": "object", - "description": "Information about where the package resides.", - "additionalProperties": false, - "required": ["include"], - "properties": { - "include": { - "$ref": "#/definitions/poetry-include-path" - }, - "from": { - "type": "string", - "description": "Where the source directory of the package resides." - }, - "format": { - "$ref": "#/definitions/poetry-package-formats" - } - } - } - }, - "include": { - "type": "array", - "description": "A list of files and folders to include.", - "items": { - "anyOf": [ - { - "$ref": "#/definitions/poetry-include-path" - }, - { - "type": "object", - "additionalProperties": false, - "required": ["path"], - "properties": { - "path": { - "$ref": "#/definitions/poetry-include-path" - }, - "format": { - "$ref": "#/definitions/poetry-package-formats" - } - } - } - ] - } - }, - "exclude": { - "type": "array", - "description": "A list of files and folders to exclude." - }, - "dependencies": { - "type": "object", - "description": "This is a hash of package name (keys) and version constraints (values) that are required to run this package.", - "required": ["python"], - "properties": { - "python": { - "$ref": "#/definitions/poetry-dependency", - "type": "string", - "description": "The Python versions the package is compatible with." - } - }, - "patternProperties": { - "^(?!python$)[a-zA-Z-_.0-9]+$": { - "$ref": "#/definitions/poetry-dependency-any" - } - } - }, - "dev-dependencies": { - "type": "object", - "description": "This is a hash of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).", - "patternProperties": { - "^[a-zA-Z-_.0-9]+$": { - "$ref": "#/definitions/poetry-dependency-any" - } - } - }, - "extras": { - "type": "object", - "patternProperties": { - "^[a-zA-Z-_.0-9]+$": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "group": { - "type": "object", - "description": "This represents groups of dependencies", - "patternProperties": { - "^[a-zA-Z-_.0-9]+$": { - "type": "object", - "description": "This represents a single dependency group", - "required": ["dependencies"], - "properties": { - "optional": { - "type": "boolean", - "description": "Whether the dependency group is optional or not" - }, - "dependencies": { - "type": "object", - "description": "The dependencies of this dependency group", - "patternProperties": { - "^[a-zA-Z-_.0-9]+$": { - "$ref": "#/definitions/poetry-dependency-any" - } - }, - "additionalProperties": false - } - }, - "additionalProperties": false - } - } - }, - "build": { - "$ref": "#/definitions/poetry-build-section" - }, - "scripts": { - "type": "object", - "description": "A hash of scripts to be installed.", - "patternProperties": { - "^[a-zA-Z-_.0-9]+$": { - "oneOf": [ - { - "$ref": "#/definitions/poetry-script-legacy" - }, - { - "$ref": "#/definitions/poetry-script-table" - } - ] - } - } - }, - "plugins": { - "type": "object", - "description": "A hash of hashes representing plugins", - "patternProperties": { - "^[a-zA-Z-_.0-9]+$": { - "type": "object", - "patternProperties": { - "^[a-zA-Z-_.0-9]+$": { - "type": "string" - } - } - } - } - }, - "urls": { - "type": "object", - "patternProperties": { - "^.+$": { - "type": "string", - "description": "The full url of the custom url." - } - } - } - } + "$ref": "https://json.schemastore.org/partial-poetry.json" } diff --git a/src/schemas/json/pyproject.json b/src/schemas/json/pyproject.json index e4a551be887..9d117d4ff9d 100644 --- a/src/schemas/json/pyproject.json +++ b/src/schemas/json/pyproject.json @@ -100,7 +100,7 @@ }, "properties": { "cibuildwheel": { - "$ref": "https://json.schemastore.org/cibuildwheel.json#/properties/tool/properties/cibuildwheel" + "$ref": "https://json.schemastore.org/partial-cibuildwheel.json" }, "mypy": { "$ref": "https://json.schemastore.org/partial-mypy.json" @@ -112,13 +112,13 @@ "$ref": "https://json.schemastore.org/hatch.json" }, "scikit-build": { - "$ref": "https://json.schemastore.org/scikit-build.json" + "$ref": "https://json.schemastore.org/partial-scikit-build.json" }, "setuptools": { - "$ref": "https://json.schemastore.org/setuptools.json" + "$ref": "https://json.schemastore.org/partial-setuptools.json" }, "poetry": { - "$ref": "https://json.schemastore.org/poetry.json" + "$ref": "https://json.schemastore.org/partial-poetry.json" }, "pdm": { "$ref": "https://json.schemastore.org/partial-pdm.json" diff --git a/src/schemas/json/scikit-build.json b/src/schemas/json/scikit-build.json index b2eb262bd20..3ea6f16afd9 100644 --- a/src/schemas/json/scikit-build.json +++ b/src/schemas/json/scikit-build.json @@ -1,469 +1,5 @@ { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://json.schemastore.org/scikit-build.json", - "$defs": { - "metadata": { - "type": "object", - "properties": { - "provider": { - "type": "string" - }, - "provider-path": { - "type": "string" - } - } - }, - "if_overrides": { - "type": "object", - "minProperties": 1, - "additionalProperties": false, - "properties": { - "python-version": { - "type": "string" - }, - "implementation-name": { - "type": "string" - }, - "implementation-version": { - "type": "string" - }, - "platform-system": { - "type": "string" - }, - "platform-machine": { - "type": "string" - }, - "platform-node": { - "type": "string" - }, - "env": { - "type": "object", - "patternProperties": { - ".*": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - }, - "additionalProperties": false, - "minProperties": 1 - } - } - } - }, - "description": "Scikit-build-core's settings.", - "type": "object", - "additionalProperties": false, - "properties": { - "cmake": { - "type": "object", - "additionalProperties": false, - "properties": { - "minimum-version": { - "type": "string", - "default": "3.15", - "description": "The minimum version of CMake to use. If CMake is not present on the system or is older than this, it will be downloaded via PyPI if possible. An empty string will disable this check." - }, - "args": { - "type": "array", - "items": { - "type": "string" - }, - "description": "A list of args to pass to CMake when configuring the project. Setting this in config or envvar will override toml. See also ``cmake.define``." - }, - "define": { - "type": "object", - "patternProperties": { - ".+": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "boolean" - } - ] - } - }, - "description": "A table of defines to pass to CMake when configuring the project. Additive." - }, - "verbose": { - "type": "boolean", - "default": false, - "description": "Verbose printout when building." - }, - "build-type": { - "type": "string", - "default": "Release", - "description": "The build type to use when building the project. Valid options are: \"Debug\", \"Release\", \"RelWithDebInfo\", \"MinSizeRel\", \"\", etc." - }, - "source-dir": { - "type": "string", - "default": ".", - "description": "The source directory to use when building the project. Currently only affects the native builder (not the setuptools plugin)." - }, - "targets": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The build targets to use when building the project. Empty builds the default target." - } - } - }, - "ninja": { - "type": "object", - "additionalProperties": false, - "properties": { - "minimum-version": { - "type": "string", - "default": "1.5", - "description": "The minimum version of Ninja to use. If Ninja is not present on the system or is older than this, it will be downloaded via PyPI if possible. An empty string will disable this check." - }, - "make-fallback": { - "type": "boolean", - "default": true, - "description": "If CMake is not present on the system or is older required, it will be downloaded via PyPI if possible. An empty string will disable this check." - } - } - }, - "logging": { - "type": "object", - "additionalProperties": false, - "properties": { - "level": { - "enum": ["NOTSET", "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"], - "default": "WARNING", - "description": "The logging level to display, \"DEBUG\", \"INFO\", \"WARNING\", and \"ERROR\" are possible options." - } - } - }, - "sdist": { - "type": "object", - "additionalProperties": false, - "properties": { - "include": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Files to include in the SDist even if they are skipped by default. Supports gitignore syntax." - }, - "exclude": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Files to exclude from the SDist even if they are included by default. Supports gitignore syntax." - }, - "reproducible": { - "type": "boolean", - "default": true, - "description": "If set to True, try to build a reproducible distribution (Unix and Python 3.9+ recommended). ``SOURCE_DATE_EPOCH`` will be used for timestamps, or a fixed value if not set." - }, - "cmake": { - "type": "boolean", - "default": false, - "description": "If set to True, CMake will be run before building the SDist." - } - } - }, - "wheel": { - "type": "object", - "additionalProperties": false, - "properties": { - "packages": { - "type": "array", - "items": { - "type": "string" - }, - "description": "A list of packages to auto-copy into the wheel. If this is not set, it will default to the first of ``src/``, ``python/``, or ```` if they exist. The prefix(s) will be stripped from the package name inside the wheel." - }, - "py-api": { - "type": "string", - "default": "", - "description": "The Python tags. The default (empty string) will use the default Python version. You can also set this to \"cp37\" to enable the CPython 3.7+ Stable ABI / Limited API (only on CPython and if the version is sufficient, otherwise this has no effect). Or you can set it to \"py3\" or \"py2.py3\" to ignore Python ABI compatibility. The ABI tag is inferred from this tag." - }, - "expand-macos-universal-tags": { - "type": "boolean", - "default": false, - "description": "Fill out extra tags that are not required. This adds \"x86_64\" and \"arm64\" to the list of platforms when \"universal2\" is used, which helps older Pip's (before 21.0.1) find the correct wheel." - }, - "install-dir": { - "type": "string", - "default": "", - "description": "The install directory for the wheel. This is relative to the platlib root. You might set this to the package name. The original dir is still at SKBUILD_PLATLIB_DIR (also SKBUILD_DATA_DIR, etc. are available). EXPERIMENTAL: An absolute path will be one level higher than the platlib root, giving access to \"/platlib\", \"/data\", \"/headers\", and \"/scripts\"." - }, - "license-files": { - "type": "array", - "items": { - "type": "string" - }, - "description": "A list of license files to include in the wheel. Supports glob patterns." - }, - "cmake": { - "type": "boolean", - "default": true, - "description": "If set to True (the default), CMake will be run before building the wheel." - }, - "platlib": { - "type": "boolean", - "description": "Target the platlib or the purelib. If not set, the default is to target the platlib if wheel.cmake is true, and the purelib otherwise." - }, - "exclude": { - "type": "array", - "items": { - "type": "string" - }, - "description": "A set of patterns to exclude from the wheel. This is additive to the SDist exclude patterns. This applies to the source files, not the final paths. Editable installs may not respect this exclusion." - } - } - }, - "backport": { - "type": "object", - "additionalProperties": false, - "properties": { - "find-python": { - "type": "string", - "default": "3.26.1", - "description": "If CMake is less than this value, backport a copy of FindPython. Set to 0 disable this, or the empty string." - } - } - }, - "editable": { - "type": "object", - "additionalProperties": false, - "properties": { - "mode": { - "enum": ["redirect", "inplace"], - "default": "redirect", - "description": "Select the editable mode to use. Can be \"redirect\" (default) or \"inplace\"." - }, - "verbose": { - "type": "boolean", - "default": true, - "description": "Turn on verbose output for the editable mode rebuilds." - }, - "rebuild": { - "type": "boolean", - "default": false, - "description": "Rebuild the project when the package is imported. The build-directory must be set." - } - } - }, - "install": { - "type": "object", - "additionalProperties": false, - "properties": { - "components": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The components to install. If empty, all default components are installed." - }, - "strip": { - "type": "boolean", - "description": "Whether to strip the binaries. True for scikit-build-core 0.5+." - } - } - }, - "generate": { - "type": "array", - "items": { - "oneOf": [ - { - "type": "object", - "additionalProperties": false, - "required": ["path", "template"], - "properties": { - "path": { - "type": "string", - "description": "The path (relative to platlib) for the file to generate.", - "minLength": 1 - }, - "template": { - "type": "string", - "description": "The template to use for the file. This includes string.Template style placeholders for all the metadata. If empty, a template-path must be set.", - "minLength": 1 - }, - "location": { - "enum": ["install", "build", "source"], - "default": "install", - "description": "The place to put the generated file. The \"build\" directory is useful for CMake files, and the \"install\" directory is useful for Python files, usually. You can also write directly to the \"source\" directory, will overwrite existing files & remember to gitignore the file." - } - } - }, - { - "type": "object", - "additionalProperties": false, - "required": ["path", "template-path"], - "properties": { - "path": { - "type": "string", - "description": "The path (relative to platlib) for the file to generate.", - "minLength": 1 - }, - "template-path": { - "type": "string", - "description": "The path to the template file. If empty, a template must be set.", - "minLength": 1 - }, - "location": { - "enum": ["install", "build", "source"], - "default": "install", - "description": "The place to put the generated file. The \"build\" directory is useful for CMake files, and the \"install\" directory is useful for Python files, usually. You can also write directly to the \"source\" directory, will overwrite existing files & remember to gitignore the file." - } - } - } - ] - } - }, - "metadata": { - "type": "object", - "description": "List dynamic metadata fields and hook locations in this table.", - "additionalProperties": false, - "properties": { - "version": { - "$ref": "#/$defs/metadata" - }, - "description": { - "$ref": "#/$defs/metadata" - }, - "license": { - "$ref": "#/$defs/metadata" - }, - "readme": { - "$ref": "#/$defs/metadata" - }, - "requires-python": { - "$ref": "#/$defs/metadata" - }, - "dependencies": { - "$ref": "#/$defs/metadata" - }, - "optional-dependencies": { - "$ref": "#/$defs/metadata" - }, - "entrypoints": { - "$ref": "#/$defs/metadata" - }, - "authors": { - "$ref": "#/$defs/metadata" - }, - "maintainers": { - "$ref": "#/$defs/metadata" - }, - "urls": { - "$ref": "#/$defs/metadata" - }, - "classifiers": { - "$ref": "#/$defs/metadata" - }, - "keywords": { - "$ref": "#/$defs/metadata" - }, - "scripts": { - "$ref": "#/$defs/metadata" - }, - "gui-scripts": { - "$ref": "#/$defs/metadata" - } - } - }, - "strict-config": { - "type": "boolean", - "default": true, - "description": "Strictly check all config options. If False, warnings will be printed for unknown options. If True, an error will be raised." - }, - "experimental": { - "type": "boolean", - "default": false, - "description": "Enable early previews of features not finalized yet." - }, - "minimum-version": { - "type": "string", - "description": "If set, this will provide a method for backward compatibility." - }, - "build-dir": { - "type": "string", - "default": "", - "description": "The build directory. Defaults to a temporary directory, but can be set." - }, - "overrides": { - "type": "array", - "items": { - "type": "object", - "required": ["if"], - "minProperties": 2, - "additionalProperties": false, - "properties": { - "if": { - "anyOf": [ - { - "$ref": "#/$defs/if_overrides" - }, - { - "type": "object", - "properties": { - "any": { - "$ref": "#/$defs/if_overrides" - } - }, - "required": ["any"], - "additionalProperties": false - } - ] - }, - "cmake": { - "$ref": "#/properties/cmake" - }, - "ninja": { - "$ref": "#/properties/ninja" - }, - "logging": { - "$ref": "#/properties/logging" - }, - "sdist": { - "$ref": "#/properties/sdist" - }, - "wheel": { - "$ref": "#/properties/wheel" - }, - "backport": { - "$ref": "#/properties/backport" - }, - "editable": { - "$ref": "#/properties/editable" - }, - "install": { - "$ref": "#/properties/install" - }, - "generate": { - "$ref": "#/properties/generate" - }, - "metadata": { - "$ref": "#/properties/metadata" - }, - "strict-config": { - "$ref": "#/properties/strict-config" - }, - "experimental": { - "$ref": "#/properties/experimental" - }, - "minimum-version": { - "$ref": "#/properties/minimum-version" - }, - "build-dir": { - "$ref": "#/properties/build-dir" - } - } - } - } - } + "$ref": "https://json.schemastore.org/partial-scikit-build.json" } diff --git a/src/schemas/json/setuptools.json b/src/schemas/json/setuptools.json index 69e1d9263d9..67a108b2b8d 100644 --- a/src/schemas/json/setuptools.json +++ b/src/schemas/json/setuptools.json @@ -1,352 +1,5 @@ { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://json.schemastore.org/setuptools.json", - "title": "``tool.setuptools`` table", - "type": "object", - "additionalProperties": false, - "properties": { - "platforms": { - "type": "array", - "items": { - "type": "string" - } - }, - "provides": { - "type": "array", - "items": { - "type": "string", - "format": "pep508-identifier" - }, - "description": "Package and virtual package names contained within this package **(not supported by pip)**" - }, - "obsoletes": { - "type": "array", - "items": { - "type": "string", - "format": "pep508-identifier" - }, - "description": "Packages which this package renders obsolete **(not supported by pip)**" - }, - "zip-safe": { - "type": "boolean", - "description": "Whether the project can be safely installed and run from a zip file. **OBSOLETE**: only relevant for ``pkg_resources``, ``easy_install`` and ``setup.py install`` in the context of ``eggs`` (**DEPRECATED**)." - }, - "script-files": { - "$comment": "TODO: is this field deprecated/should be removed?", - "type": "array", - "items": { - "type": "string" - }, - "description": "Legacy way of defining scripts (entry-points are preferred). Equivalent to the ``script`` keyword in ``setup.py`` (it was renamed to avoid confusion with entry-point based ``project.scripts`` defined in :pep:`621`). **DISCOURAGED**: generic script wrappers are tricky and may not work properly. Whenever possible, please use ``project.scripts`` instead." - }, - "eager-resources": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Resources that should be extracted together, if any of them is needed, or if any C extensions included in the project are imported. **OBSOLETE**: only relevant for ``pkg_resources``, ``easy_install`` and ``setup.py install`` in the context of ``eggs`` (**DEPRECATED**)." - }, - "packages": { - "oneOf": [ - { - "title": "Array of Python package identifiers", - "type": "array", - "items": { - "$ref": "#/definitions/package-name" - } - }, - { - "$ref": "#/definitions/find-directive" - } - ], - "description": "Packages that should be included in the distribution. It can be given either as a list of package identifiers or as a ``dict``-like structure with a single key ``find`` which corresponds to a dynamic call to ``setuptools.config.expand.find_packages`` function. The ``find`` key is associated with a nested ``dict``-like structure that can contain ``where``, ``include``, ``exclude`` and ``namespaces`` keys, mimicking the keyword arguments of the associated function." - }, - "package-dir": { - "type": "object", - "additionalProperties": false, - "propertyNames": { - "anyOf": [ - { - "const": "" - }, - { - "$ref": "#/definitions/package-name" - } - ] - }, - "patternProperties": { - "^.*$": { - "type": "string" - } - }, - "description": ":class:`dict`-like structure mapping from package names to directories where their code can be found. The empty string (as key) means that all packages are contained inside the given directory will be included in the distribution." - }, - "package-data": { - "type": "object", - "additionalProperties": false, - "propertyNames": { - "anyOf": [ - { - "type": "string", - "format": "python-module-name" - }, - { - "const": "*" - } - ] - }, - "patternProperties": { - "^.*$": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "description": "Mapping from package names to lists of glob patterns. Usually this option is not needed when using ``include-package-data = true`` For more information on how to include data files, check ``setuptools`` `docs `_." - }, - "include-package-data": { - "type": "boolean", - "description": "Automatically include any data files inside the package directories that are specified by ``MANIFEST.in`` For more information on how to include data files, check ``setuptools`` `docs `_." - }, - "exclude-package-data": { - "type": "object", - "additionalProperties": false, - "propertyNames": { - "anyOf": [ - { - "type": "string", - "format": "python-module-name" - }, - { - "const": "*" - } - ] - }, - "patternProperties": { - "^.*$": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "description": "Mapping from package names to lists of glob patterns that should be excluded For more information on how to include data files, check ``setuptools`` `docs `_." - }, - "namespace-packages": { - "$comment": "https://setuptools.pypa.io/en/latest/userguide/package_discovery.html", - "type": "array", - "items": { - "type": "string", - "format": "python-module-name" - }, - "description": "**DEPRECATED**: use implicit namespaces instead (:pep:`420`)." - }, - "py-modules": { - "$comment": "TODO: clarify the relationship with ``packages``", - "description": "Modules that setuptools will manipulate", - "type": "array", - "items": { - "type": "string", - "format": "python-module-name" - } - }, - "data-files": { - "type": "object", - "patternProperties": { - "^.*$": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "description": "``dict``-like structure where each key represents a directory and the value is a list of glob patterns that should be installed in them. **DISCOURAGED**: please notice this might not work as expected with wheels. Whenever possible, consider using data files inside the package directories (or create a new namespace package that only contains data files). See `data files support `_." - }, - "cmdclass": { - "type": "object", - "patternProperties": { - "^.*$": { - "type": "string", - "format": "python-qualified-identifier" - } - }, - "description": "Mapping of distutils-style command names to ``setuptools.Command`` subclasses which in turn should be represented by strings with a qualified class name (i.e., \"dotted\" form with module), e.g.::\n\n cmdclass = {mycmd = \"pkg.subpkg.module.CommandClass\"}\n\n The command class should be a directly defined at the top-level of the containing module (no class nesting)." - }, - "license-files": { - "$comment": "TODO: revise if PEP 639 is accepted. Probably ``project.license-files``?", - "type": "array", - "items": { - "type": "string" - }, - "description": "**PROVISIONAL**: list of glob patterns for all license files being distributed. (likely to become standard with :pep:`639`). By default: ``['LICEN[CS]E*', 'COPYING*', 'NOTICE*', 'AUTHORS*']``" - }, - "dynamic": { - "type": "object", - "description": "Instructions for loading :pep:`621`-related metadata dynamically", - "additionalProperties": false, - "properties": { - "version": { - "oneOf": [ - { - "$ref": "#/definitions/attr-directive" - }, - { - "$ref": "#/definitions/file-directive" - } - ], - "description": "A version dynamically loaded via either the ``attr:`` or ``file:`` directives. Please make sure the given file or attribute respects :pep:`440`. Also ensure to set ``project.dynamic`` accordingly." - }, - "classifiers": { - "$ref": "#/definitions/file-directive" - }, - "description": { - "$ref": "#/definitions/file-directive" - }, - "entry-points": { - "$ref": "#/definitions/file-directive" - }, - "dependencies": { - "$ref": "#/definitions/file-directive-for-dependencies" - }, - "optional-dependencies": { - "type": "object", - "propertyNames": { - "type": "string", - "format": "python-identifier" - }, - "additionalProperties": false, - "patternProperties": { - ".+": { - "$ref": "#/definitions/file-directive-for-dependencies" - } - } - }, - "readme": { - "type": "object", - "anyOf": [ - { - "$ref": "#/definitions/file-directive" - }, - { - "type": "object", - "properties": { - "content-type": { - "type": "string" - }, - "file": { - "$ref": "#/definitions/file-directive/properties/file" - } - }, - "additionalProperties": false - } - ], - "required": ["file"] - } - } - } - }, - "definitions": { - "package-name": { - "title": "Valid package name", - "description": "Valid package name (importable or :pep:`561`).", - "type": "string", - "anyOf": [ - { - "type": "string", - "format": "python-module-name" - }, - { - "type": "string", - "format": "pep561-stub-name" - } - ] - }, - "file-directive": { - "title": "'file:' directive", - "description": "Value is read from a file (or list of files and then concatenated)", - "type": "object", - "additionalProperties": false, - "properties": { - "file": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ] - } - }, - "required": ["file"] - }, - "file-directive-for-dependencies": { - "title": "'file:' directive for dependencies", - "allOf": [ - { - "description": "**BETA**: subset of the ``requirements.txt`` format without ``pip`` flags and options (one :pep:`508`-compliant string per line, lines that are blank or start with ``#`` are excluded). See `dynamic metadata `_." - }, - { - "$ref": "#/definitions/file-directive" - } - ] - }, - "attr-directive": { - "title": "'attr:' directive", - "type": "object", - "additionalProperties": false, - "properties": { - "attr": { - "type": "string", - "format": "python-qualified-identifier" - } - }, - "required": ["attr"], - "description": "Value is read from a module attribute. Supports callables and iterables; unsupported types are cast via ``str()``" - }, - "find-directive": { - "title": "'find:' directive", - "type": "object", - "additionalProperties": false, - "properties": { - "find": { - "type": "object", - "additionalProperties": false, - "properties": { - "where": { - "description": "Directories to be searched for packages (Unix-style relative path)", - "type": "array", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Exclude packages that match the values listed in this field. Can container shell-style wildcards (e.g. ``'pkg.*'``)" - }, - "include": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Restrict the found packages to just the ones listed in this field. Can container shell-style wildcards (e.g. ``'pkg.*'``)" - }, - "namespaces": { - "type": "boolean", - "description": "When ``True``, directories without a ``__init__.py`` file will also be scanned for :pep:`420`-style implicit namespaces" - } - }, - "description": "Dynamic `package discovery `_." - } - } - } - }, - "description": "``setuptools``-specific configurations that can be set by users that require customization. These configurations are completely optional and probably can be skipped when creating simple packages. They are equivalent to some of the `Keywords `_ used by the ``setup.py`` file, and can be set via the ``tool.setuptools`` table. It considers only ``setuptools`` `parameters `_ that are not covered by :pep:`621`; and intentionally excludes ``dependency_links`` and ``setup_requires`` (incompatible with modern workflows/standards)." + "$ref": "https://json.schemastore.org/partial-setuptools.json" }