Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/pyproject/_shared/latest--partial-poetry.json
Parent schema pyproject
Type: object

Properties

package-mode boolean

Whether Poetry operates in package mode or not.

Default: true
name string

Package name.

version string

Version of the package. It should follow semantic versioning, but it is not enforced.

description string

Short package description.

pattern=^[^ ]*$
keywords string[]
homepage string

Homepage URL for the project.

format=uri
repository string

Repository URL for the project.

format=uri
documentation string

Documentation URL for the project.

format=uri
license string

License name.

List of authors that contributed to the package. This is typically the main maintainers, not the full list.

List of maintainers, other than the original author(s), that upkeep the package.

readme string | string[]
classifiers string[]

A list of trove classifiers.

packages object[]

A list of packages to include in the final distribution.

include poetry-include-path | object[]

A list of files and folders to include.

exclude string[]

A list of files and folders to exclude.

This is a hash of package name (keys) and version constraints (values) that are required to run this package.

1 nested properties
dev-dependencies object

This is a hash of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).

extras object
group object

This represents groups of dependencies

scripts object

A hash of scripts to be installed.

plugins object

A hash of hashes representing plugins

urls object
source object | object[]

Definitions

poetry-name string

Package name.

poetry-version string

Version of the package. It should follow semantic versioning, but it is not enforced.

poetry-description string

Short package description.

poetry-author-pattern string

Pattern that matches Name <email> like 'King Arthur' or 'Miss Islington <[email protected]>'.

poetry-authors poetry-author-pattern[]

List of authors that contributed to the package. This is typically the main maintainers, not the full list.

poetry-maintainers poetry-author-pattern[]

List of maintainers, other than the original author(s), that upkeep the package.

poetry-include-path string

Path to file or directory to include.

poetry-package-format string

A Python packaging format.

poetry-package-formats poetry-package-format | poetry-package-format[]

The format(s) for which the package must be included.

poetry-dependency-any poetry-dependency | poetry-long-dependency | poetry-git-dependency | poetry-file-dependency | poetry-path-dependency | poetry-url-dependency | poetry-multiple-constraints-dependency
poetry-pep440-version string

A version constraint. Validates against the PEP 440's version pattern.

poetry-dependency string

A version constraint. Validates against the PEP 440's version pattern.

poetry-long-dependency object
version string required

A version constraint. Validates against the PEP 440's version pattern.

python string

The python versions for which the dependency should be installed.

platform string

The platform(s) for which the dependency should be installed.

markers string

The PEP 508 compliant environment markers for which the dependency should be installed.

allow-prereleases boolean

Whether the dependency allows prereleases or not.

allows-prereleases boolean

Whether the dependency allows prereleases or not.

optional boolean

Whether the dependency is optional or not.

extras string[]

The required extras for this dependency.

source string

The exclusive source used to search for this dependency.

poetry-git-dependency object
git string | string required

The url of the git repository.

branch string

The branch to checkout.

tag string

The tag to checkout.

rev string

The revision to checkout.

subdirectory string

The relative path to the directory where the package is located.

python string

The python versions for which the dependency should be installed.

platform string

The platform(s) for which the dependency should be installed.

markers string

The PEP 508 compliant environment markers for which the dependency should be installed.

allow-prereleases boolean

Whether the dependency allows prereleases or not.

allows-prereleases boolean

Whether the dependency allows prereleases or not.

optional boolean

Whether the dependency is optional or not.

extras string[]

The required extras for this dependency.

develop boolean

Whether to install the dependency in development mode.

poetry-file-dependency object
file string required

The path to the file.

python string

The python versions for which the dependency should be installed.

platform string

The platform(s) for which the dependency should be installed.

markers string

The PEP 508 compliant environment markers for which the dependency should be installed.

optional boolean

Whether the dependency is optional or not.

extras string[]

The required extras for this dependency.

poetry-path-dependency object
path string required

The path to the dependency.

python string

The python versions for which the dependency should be installed.

platform string

The platform(s) for which the dependency should be installed.

markers string

The PEP 508 compliant environment markers for which the dependency should be installed.

optional boolean

Whether the dependency is optional or not.

extras string[]

The required extras for this dependency.

develop boolean

Whether to install the dependency in development mode.

poetry-url-dependency object
url string required

The url to the file.

python string

The python versions for which the dependency should be installed.

platform string

The platform(s) for which the dependency should be installed.

markers string

The PEP 508 compliant environment markers for which the dependency should be installed.

optional boolean

Whether the dependency is optional or not.

extras string[]

The required extras for this dependency.

poetry-multiple-constraints-dependency poetry-dependency | poetry-long-dependency | poetry-git-dependency | poetry-file-dependency | poetry-path-dependency | poetry-url-dependency[]
poetry-script-table poetry-extra-script-legacy | poetry-extra-scripts
poetry-script-legacy string

A simple script pointing to a callable object.

poetry-extra-scripts object

Either a console entry point or a script file that'll be included in the distribution package.

reference string required

If type is file this is the relative path of the script file, if console it is the module name.

type string required

Value can be either file or console.

Values: "file" "console"
extras string[]

The required extras for this script. Only applicable if type is console.

poetry-extra-script-legacy object

A script that should be installed only if extras are activated.

callable string

A simple script pointing to a callable object.

extras string[]

The required extras for this script.

poetry-build-script string

The python script file used to build extensions.

poetry-build-config object

Build specific configurations.

generate-setup-file boolean

Generate and include a setup.py file in sdist.

Default: true
script string

The python script file used to build extensions.

poetry-build-section poetry-build-script | poetry-build-config
poetry-priority enum