Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 10 additions & 13 deletions src/schemas/json/pyproject.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://json.schemastore.org/pyproject.json",
"$comment": "there are multiple resources describing pyproject.toml. The canonical reference is at https://packaging.python.org/en/latest/specifications/declaring-project-metadata/, which refers to multiple proposals such as PEP 517, PEP 518 and PEP 621",
"$comment": "there are multiple resources describing `pyproject.toml`. The canonical reference is at https://packaging.python.org/en/latest/specifications/declaring-project-metadata/, which refers to multiple proposals such as PEP 517, PEP 518 and PEP 621",
"x-tombi-toml-version": "v1.0.0",
"x-tombi-table-keys-order": "schema",
"x-tombi-string-formats": ["email", "uri"],
Expand Down Expand Up @@ -292,11 +292,11 @@
"examples": [">= 3.7"]
},
"license": {
"$comment": "PEP 639 specifies current behavior (text / file subkey) will be deprecated, but this PEP is still under provisional status.",
"$comment": "PEP 639: Table format (text/file subkey) is deprecated. SPDX license expression string is recommended.",
"title": "Project license",
"description": "For now it is a table with either:\n- `file` key specifying a relative path to a license file, or\n- `text` key containing full license content\n\nNewer tool may accept a single [SPDX license expression](https://spdx.github.io/spdx-spec/v2.2.2/SPDX-license-expressions/) string instead of a table.",
"markdownDescription": "For now it is a table with either:\n- `file` key specifying a relative path to a license file, or\n- `text` key containing full license content\n\nNewer tool may accept a single [SPDX license expression](https://spdx.github.io/spdx-spec/v2.2.2/SPDX-license-expressions/) string instead of a table.",
"x-intellij-html-description": "<p>For now it is a table with either:</p><ul><li><code>file</code> key specifying a relative path to a license file, or</li><li><code>text</code> key containing full license content</li></ul><p>Newer tool may accept a single <a href=\"https://spdx.github.io/spdx-spec/v2.2.2/SPDX-license-expressions/\">SPDX license expression</a> string instead of a table.</p>",
"description": "A string containing a valid [SPDX license expression](https://spdx.github.io/spdx-spec/v2.2.2/SPDX-license-expressions/) (recommended), or a table with either:\n- `file` key specifying a relative path to a license file (deprecated per PEP 639), or\n- `text` key containing full license content (deprecated per PEP 639)",
"markdownDescription": "A string containing a valid [SPDX license expression](https://spdx.github.io/spdx-spec/v2.2.2/SPDX-license-expressions/) (recommended), or a table with either:\n- `file` key specifying a relative path to a license file (deprecated per PEP 639), or\n- `text` key containing full license content (deprecated per PEP 639)",
"x-intellij-html-description": "<p>A string containing a valid <a href=\"https://spdx.github.io/spdx-spec/v2.2.2/SPDX-license-expressions/\">SPDX license expression</a> (recommended), or a table with either:</p><ul><li><code>file</code> key specifying a relative path to a license file (deprecated per PEP 639), or</li><li><code>text</code> key containing full license content (deprecated per PEP 639)</li></ul><p>",
"x-taplo": {
"links": {
"key": "https://packaging.python.org/en/latest/specifications/pyproject-toml/#license"
Expand All @@ -307,9 +307,11 @@
"type": "object",
"additionalProperties": false,
"required": ["file"],
"deprecated": true,
"properties": {
"file": {
"title": "License file path",
"description": "Deprecated per [PEP 639](https://peps.python.org/pep-0639/#add-license-file-key). Instead, list license file paths in the top-level `license-files` field and specify the license using an SPDX expression string in the `license` field.",
"type": "string"
}
}
Expand All @@ -318,6 +320,7 @@
"type": "object",
"additionalProperties": false,
"required": ["text"],
"deprecated": true,
"properties": {
"text": {
"title": "License text",
Expand All @@ -326,17 +329,11 @@
}
},
{
"$comment": "Maybe add 'deprecated' keyword to table usage when SPDX license expression usage is finalized. But that requires 2019-09 draft.",
"$comment": "SPDX license expression (recommended per PEP 639)",
"type": "string"
}
],
"examples": [
{
"text": "To the extent possible under law, the author(s) who associated this software with CC0 have dedicated all copyright and related and neighboring rights to this software to the public domain worldwide. This software is distributed without any warranty."
},
{
"file": "LICENSE"
},
"MIT",
"BSD-2-Clause OR Apache-2.0",
"LicenseRef-Proprietary"
Expand Down Expand Up @@ -1030,7 +1027,7 @@
"poe": {
"$ref": "partial-poe.json",
"title": "Task Runner",
"description": "A task runner that works well with pyproject.toml files."
"description": "A task runner that works well with `pyproject.toml` files."
},
"poetry": {
"$ref": "partial-poetry.json",
Expand Down