Hide navigation sidebar
Hide table of contents sidebar
Back to top
Toggle table of contents sidebar

# JSON Schemas

The following JSON schemas are used in `validate-pyproject`. Automatically generated documentation is also available on the Schemas page.

## `pyproject.toml`

    {
      "$schema": "http://json-schema.org/draft-07/schema#",

      "$id": "https://packaging.python.org/en/latest/specifications/declaring-build-dependencies/",
      "title": "Data structure for ``pyproject.toml`` files",
      "$$description": [
        "File format containing build-time configurations for the Python ecosystem. ",
        ":pep:`517` initially defined a build-system independent format for source trees",
        "which was complemented by :pep:`518` to provide a way of specifying dependencies ",
        "for building Python projects.",
        "Please notice the ``project`` table (as initially defined in  :pep:`621`) is not included",
        "in this schema and should be considered separately."
      ],

      "type": "object",
      "additionalProperties": false,

      "properties": {
        "build-system": {
          "type": "object",
          "description": "Table used to store build-related data",
          "additionalProperties": false,

          "properties": {
            "requires": {
              "type": "array",
              "$$description": [
                "List of dependencies in the :pep:`508` format required to execute the build",
                "system. Please notice that the resulting dependency graph",
                "**MUST NOT contain cycles**"
              ],
              "items": {
                "type": "string"
              }
            },
            "build-backend": {
              "type": "string",
              "description":
                "Python object that will be used to perform the build according to :pep:`517`",
              "format": "pep517-backend-reference"
            },
            "backend-path": {
              "type": "array",
              "$$description": [
                "List of directories to be prepended to ``sys.path`` when loading the",
                "back-end, and running its hooks"
              ],
              "items": {
                "type": "string",
                "$comment": "Should be a path (TODO: enforce it with format?)"
              }
            }
          },
          "required": ["requires"]
        },

        "project": {
          "$ref": "https://packaging.python.org/en/latest/specifications/declaring-project-metadata/"
        },

        "tool": {
          "type": "object"
        }
      }
    }

## `project` table

    {
      "$schema": "http://json-schema.org/draft-07/schema#",

      "$id": "https://packaging.python.org/en/latest/specifications/declaring-project-metadata/",
      "title": "Package metadata stored in the ``project`` table",
      "$$description": [
        "Data structure for the **project** table inside ``pyproject.toml``",
        "(as initially defined in :pep:`621`)"
      ],

      "type": "object",
      "properties": {
        "name": {
           "type": "string",
           "description":
             "The name (primary identifier) of the project. MUST be statically defined.",
           "format": "pep508-identifier"
        },
        "version": {
          "type": "string",
          "description": "The version of the project as supported by :pep:`440`.",
          "format": "pep440"
        },
        "description": {
          "type": "string",
          "$$description": [
            "The `summary description of the project",
            "<https://packaging.python.org/specifications/core-metadata/#summary>`_"
          ]
        },
        "readme": {
          "$$description": [
            "`Full/detailed description of the project in the form of a README",
            "<https://peps.python.org/pep-0621/#readme>`_",
            "with meaning similar to the one defined in `core metadata's Description",
            "<https://packaging.python.org/specifications/core-metadata/#description>`_"
          ],
          "oneOf": [
            {
              "type": "string",
              "$$description": [
                "Relative path to a text file (UTF-8) containing the full description",
                "of the project. If the file path ends in case-insensitive ``.md`` or",
                "``.rst`` suffixes, then the content-type is respectively",
                "``text/markdown`` or ``text/x-rst``"
              ]
            },
            {
              "type": "object",
              "allOf": [
                {
                  "anyOf": [
                    {
                      "properties": {
                        "file": {
                          "type": "string",
                          "$$description": [
                            "Relative path to a text file containing the full description",
                            "of the project."
                          ]
                        }
                      },
                      "required": ["file"]
                    },
                    {
                      "properties": {
                        "text": {
                          "type": "string",
                          "description": "Full text describing the project."
                        }
                      },
                      "required": ["text"]
                    }
                  ]
                },
                {
                  "properties": {
                    "content-type" : {
                      "type": "string",
                      "$$description": [
                        "Content-type (:rfc:`1341`) of the full description",
                        "(e.g. ``text/markdown``). The ``charset`` parameter is assumed",
                        "UTF-8 when not present."
                      ],
                      "$comment": "TODO: add regex pattern or format?"
                    }
                  },
                  "required": ["content-type"]
                }
              ]
            }
          ]
        },
        "requires-python": {
          "type": "string",
          "format": "pep508-versionspec",
          "$$description": [
            "`The Python version requirements of the project",
            "<https://packaging.python.org/specifications/core-metadata/#requires-python>`_."
          ]
        },
        "license": {
          "description":
            "`Project license <https://peps.python.org/pep-0621/#license>`_.",
          "oneOf": [
            {
              "properties": {
                "file": {
                  "type": "string",
                  "$$description": [
                    "Relative path to the file (UTF-8) which contains the license for the",
                    "project."
                  ]
                }
              },
              "required": ["file"]
            },
            {
              "properties": {
                "text": {
                  "type": "string",
                  "$$description": [
                    "The license of the project whose meaning is that of the",
                    "`License field from the core metadata",
                    "<https://packaging.python.org/specifications/core-metadata/#license>`_."
                  ]
                }
              },
              "required": ["text"]
            }
          ]
        },
        "authors": {
          "type": "array",
          "items": {"$ref": "#/definitions/author"},
          "$$description": [
            "The people or organizations considered to be the 'authors' of the project.",
            "The exact meaning is open to interpretation (e.g. original or primary authors,",
            "current maintainers, or owners of the package)."
          ]
        },
        "maintainers": {
          "type": "array",
          "items": {"$ref": "#/definitions/author"},
          "$$description": [
            "The people or organizations considered to be the 'maintainers' of the project.",
            "Similarly to ``authors``, the exact meaning is open to interpretation."
          ]
        },
        "keywords": {
          "type": "array",
          "items": {"type": "string"},
          "description":
            "List of keywords to assist searching for the distribution in a larger catalog."
        },
        "classifiers": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "trove-classifier",
            "description": "`PyPI classifier <https://pypi.org/classifiers/>`_."
          },
          "$$description": [
            "`Trove classifiers <https://pypi.org/classifiers/>`_",
            "which apply to the project."
          ]
        },
        "urls": {
          "type": "object",
          "description": "URLs associated with the project in the form ``label => value``.",
          "additionalProperties": false,
          "patternProperties": {
            "^.+$": {"type": "string", "format": "url"}
          }
        },
        "scripts": {
          "$ref": "#/definitions/entry-point-group",
          "$$description": [
            "Instruct the installer to create command-line wrappers for the given",
            "`entry points <https://packaging.python.org/specifications/entry-points/>`_."
          ]
        },
        "gui-scripts": {
          "$ref": "#/definitions/entry-point-group",
          "$$description": [
            "Instruct the installer to create GUI wrappers for the given",
            "`entry points <https://packaging.python.org/specifications/entry-points/>`_.",
            "The difference between ``scripts`` and ``gui-scripts`` is only relevant in",
            "Windows."
          ]
        },
        "entry-points": {
          "$$description": [
            "Instruct the installer to expose the given modules/functions via",
            "``entry-point`` discovery mechanism (useful for plugins).",
            "More information available in the `Python packaging guide",
            "<https://packaging.python.org/specifications/entry-points/>`_."
          ],
          "propertyNames": {"format": "python-entrypoint-group"},
          "additionalProperties": false,
          "patternProperties": {
            "^.+$": {"$ref": "#/definitions/entry-point-group"}
          }
        },
        "dependencies": {
          "type": "array",
          "description": "Project (mandatory) dependencies.",
          "items": {"$ref": "#/definitions/dependency"}
        },
        "optional-dependencies": {
          "type": "object",
          "description": "Optional dependency for the project",
          "propertyNames": {"format": "pep508-identifier"},
          "additionalProperties": false,
          "patternProperties": {
            "^.+$": {
              "type": "array",
              "items": {"$ref": "#/definitions/dependency"}
            }
          }
        },
        "dynamic": {
          "type": "array",
          "$$description": [
            "Specifies which fields are intentionally unspecified and expected to be",
            "dynamically provided by build tools"
          ],
          "items": {
            "enum": [
              "version",
              "description",
              "readme",
              "requires-python",
              "license",
              "authors",
              "maintainers",
              "keywords",
              "classifiers",
              "urls",
              "scripts",
              "gui-scripts",
              "entry-points",
              "dependencies",
              "optional-dependencies"
            ]
          }
        }
      },
      "required": ["name"],
      "additionalProperties": false,
      "if": {
        "not": {
          "required": ["dynamic"],
          "properties": {
            "dynamic": {
              "contains": {"const": "version"},
              "$$description": ["version is listed in ``dynamic``"]
            }
          }
        },
        "$$comment": [
          "According to :pep:`621`:",
          "    If the core metadata specification lists a field as \"Required\", then",
          "    the metadata MUST specify the field statically or list it in dynamic",
          "In turn, `core metadata`_ defines:",
          "    The required fields are: Metadata-Version, Name, Version.",
          "    All the other fields are optional.",
          "Since ``Metadata-Version`` is defined by the build back-end, ``name`` and",
          "``version`` are the only mandatory information in ``pyproject.toml``.",
          ".. _core metadata: https://packaging.python.org/specifications/core-metadata/"
        ]
      },
      "then": {
        "required": ["version"],
        "$$description": ["version should be statically defined in the ``version`` field"]
      },

      "definitions": {
        "author": {
          "$id": "#/definitions/author",
          "title": "Author or Maintainer",
          "$comment": "https://peps.python.org/pep-0621/#authors-maintainers",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "name": {
              "type": "string",
              "$$description": [
                "MUST be a valid email name, i.e. whatever can be put as a name, before an",
                "email, in :rfc:`822`."
              ]
            },
            "email": {
              "type": "string",
              "format": "idn-email",
              "description": "MUST be a valid email address"
            }
          }
        },
        "entry-point-group": {
          "$id": "#/definitions/entry-point-group",
          "title": "Entry-points",
          "type": "object",
          "$$description": [
            "Entry-points are grouped together to indicate what sort of capabilities they",
            "provide.",
            "See the `packaging guides",
            "<https://packaging.python.org/specifications/entry-points/>`_",
            "and `setuptools docs",
            "<https://setuptools.pypa.io/en/latest/userguide/entry_point.html>`_",
            "for more information."
          ],
          "propertyNames": {"format": "python-entrypoint-name"},
          "additionalProperties": false,
          "patternProperties": {
            "^.+$": {
              "type": "string",
              "$$description": [
                "Reference to a Python object. It is either in the form",
                "``importable.module``, or ``importable.module:object.attr``."
              ],
              "format": "python-entrypoint-reference",
              "$comment": "https://packaging.python.org/specifications/entry-points/"
            }
          }
        },
        "dependency": {
          "$id": "#/definitions/dependency",
          "title": "Dependency",
          "type": "string",
          "description": "Project dependency specification according to PEP 508",
          "format": "pep508"
        }
      }
    }

## `tool` table

### `tool.setuptools`

    {
      "$schema": "http://json-schema.org/draft-07/schema#",

      "$id": "https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html",
      "title": "``tool.setuptools`` table",
      "$$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",
        "<https://setuptools.pypa.io/en/latest/references/keywords.html>`_",
        "used by the ``setup.py`` file, and can be set via the ``tool.setuptools`` table.",
        "It considers only ``setuptools`` `parameters",
        "<https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html#setuptools-specific-configuration>`_",
        "that are not covered by :pep:`621`; and intentionally excludes ``dependency_links``",
        "and ``setup_requires`` (incompatible with modern workflows/standards)."
      ],

      "type": "object",
      "additionalProperties": false,
      "properties": {
        "platforms": {
          "type": "array",
          "items": {"type": "string"}
        },
        "provides": {
          "$$description": [
            "Package and virtual package names contained within this package",
            "**(not supported by pip)**"
          ],
          "type": "array",
          "items": {"type": "string", "format": "pep508-identifier"}
        },
        "obsoletes": {
          "$$description": [
            "Packages which this package renders obsolete",
            "**(not supported by pip)**"
          ],
          "type": "array",
          "items": {"type": "string", "format": "pep508-identifier"}
        },
        "zip-safe": {
          "$$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**)."
          ],
          "type": "boolean"
        },
        "script-files": {
          "$$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."
          ],
          "type": "array",
          "items": {"type": "string"},
          "$comment": "TODO: is this field deprecated/should be removed?"
        },
        "eager-resources": {
          "$$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**)."
          ],
          "type": "array",
          "items": {"type": "string"}
        },
        "packages": {
          "$$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."
          ],
          "oneOf": [
            {
              "title": "Array of Python package identifiers",
              "type": "array",
              "items": {"$ref": "#/definitions/package-name"}
            },
            {"$ref": "#/definitions/find-directive"}
          ]
        },
        "package-dir": {
          "$$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."
          ],
          "type": "object",
          "additionalProperties": false,
          "propertyNames": {
            "anyOf": [{"const": ""}, {"$ref": "#/definitions/package-name"}]
          },
          "patternProperties": {
            "^.*$": {"type": "string" }
          }
        },
        "package-data": {
          "$$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",
            "<https://setuptools.pypa.io/en/latest/userguide/datafiles.html>`_."
          ],
          "type": "object",
          "additionalProperties": false,
          "propertyNames": {
            "anyOf": [{"type": "string", "format": "python-module-name"}, {"const": "*"}]
          },
          "patternProperties": {
            "^.*$": {"type": "array", "items": {"type": "string"}}
          }
        },
        "include-package-data": {
          "$$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",
            "<https://setuptools.pypa.io/en/latest/userguide/datafiles.html>`_."
          ],
          "type": "boolean"
        },
        "exclude-package-data": {
          "$$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",
            "<https://setuptools.pypa.io/en/latest/userguide/datafiles.html>`_."
          ],
          "type": "object",
          "additionalProperties": false,
          "propertyNames": {
            "anyOf": [{"type": "string", "format": "python-module-name"}, {"const": "*"}]
          },
          "patternProperties": {
              "^.*$": {"type": "array", "items": {"type": "string"}}
          }
        },
        "namespace-packages": {
          "type": "array",
          "items": {"type": "string", "format": "python-module-name"},
          "$comment": "https://setuptools.pypa.io/en/latest/userguide/package_discovery.html",
          "description": "**DEPRECATED**: use implicit namespaces instead (:pep:`420`)."
        },
        "py-modules": {
          "description": "Modules that setuptools will manipulate",
          "type": "array",
          "items": {"type": "string", "format": "python-module-name"},
          "$comment": "TODO: clarify the relationship with ``packages``"
        },
        "data-files": {
          "$$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",
            "<https://setuptools.pypa.io/en/latest/userguide/datafiles.html>`_."
          ],
          "type": "object",
          "patternProperties": {
              "^.*$": {"type": "array", "items": {"type": "string"}}
          }
        },
        "cmdclass": {
          "$$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)."
          ],
          "type": "object",
          "patternProperties": {
              "^.*$": {"type": "string", "format": "python-qualified-identifier"}
          }
        },
        "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*']``"
          ],
          "$comment": "TODO: revise if PEP 639 is accepted. Probably ``project.license-files``?"
        },
        "dynamic": {
          "type": "object",
          "description": "Instructions for loading :pep:`621`-related metadata dynamically",
          "additionalProperties": false,
          "properties": {
            "version": {
              "$$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."
              ],
              "oneOf": [
                {"$ref": "#/definitions/attr-directive"},
                {"$ref": "#/definitions/file-directive"}
              ]
            },
            "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": {
          "$id": "#/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": {
          "$id": "#/definitions/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",
                "<https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html#dynamic-metadata>`_."
              ]
            },
            {"$ref": "#/definitions/file-directive"}
          ]
        },
        "attr-directive": {
          "title": "'attr:' directive",
          "$id": "#/definitions/attr-directive",
          "$$description": [
            "Value is read from a module attribute. Supports callables and iterables;",
            "unsupported types are cast via ``str()``"
          ],
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "attr": {"type": "string", "format": "python-qualified-identifier"}
          },
          "required": ["attr"]
        },
        "find-directive": {
          "$id": "#/definitions/find-directive",
          "title": "'find:' directive",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "find": {
              "type": "object",
              "$$description": [
                "Dynamic `package discovery",
                "<https://setuptools.pypa.io/en/latest/userguide/package_discovery.html>`_."
              ],
              "additionalProperties": false,
              "properties": {
                "where": {
                  "description":
                    "Directories to be searched for packages (Unix-style relative path)",
                  "type": "array",
                  "items": {"type": "string"}
                },
                "exclude": {
                  "type": "array",
                  "$$description": [
                    "Exclude packages that match the values listed in this field.",
                    "Can container shell-style wildcards (e.g. ``'pkg.*'``)"
                  ],
                  "items": {"type": "string"}
                },
                "include": {
                  "type": "array",
                  "$$description": [
                    "Restrict the found packages to just the ones listed in this field.",
                    "Can container shell-style wildcards (e.g. ``'pkg.*'``)"
                  ],
                  "items": {"type": "string"}
                },
                "namespaces": {
                  "type": "boolean",
                  "$$description": [
                    "When ``True``, directories without a ``__init__.py`` file will also",
                    "be scanned for :pep:`420`-style implicit namespaces"
                  ]
                }
              }
            }
          }
        }
      }
    }