Type object
File match pylock.toml pylock.*.toml
Schema URL https://catalog.lintel.tools/schemas/schemastore/pylock/latest.json
Source https://www.schemastore.org/pylock.json

Validate with Lintel

npx @lintel/lintel check
Type: object

One of

1. 1.0 object

Definitions

tool Record<string, object>

Similar usage as that of the [tool] table from the pyproject.toml specification, but at the package version level instead of at the lock file level (which is also available via [tool]).

url string

The URL to the source tree.

path string

The path to the local directory of the source tree.

upload-time

The time the file was uploaded (UTC). Must be specified as a datetime literal.

size integer

The size of the archive file.

hashes Record<string, string>

Known hash values of the file where the key is the hash algorithm and the value is the hash value.

subdirectory string

The subdirectory within the source tree where the project root of the project is (e.g. the location of the pyproject.toml file).

vcs object

Record the version control system details for the source tree it contains.

type string

The type of version control system used.

url string

The URL to the source tree.

path string

The path to the local directory of the source tree.

requested-revision string

The branch/tag/ref/commit/revision/etc. that the user requested.

commit-id string

The exact commit/revision number that is to be installed.

subdirectory string

The subdirectory within the source tree where the project root of the project is (e.g. the location of the pyproject.toml file).

directory object

Record the local directory details for the source tree it contains.

path string

The local directory where the source tree is.

editable boolean

A flag representing whether the source tree was an editable install at lock time.

Default: false
subdirectory string

The subdirectory within the source tree where the project root of the project is (e.g. the location of the pyproject.toml file).

archive object

A direct reference to an archive file to install from (this can include wheels and sdists, as well as other archive formats containing a source tree).

url string

The URL to the source tree.

path string

The path to the local directory of the source tree.

size integer

The size of the archive file.

upload-time

The time the file was uploaded (UTC). Must be specified as a datetime literal.

hashes Record<string, string>

Known hash values of the file where the key is the hash algorithm and the value is the hash value.

subdirectory string

The subdirectory within the source tree where the project root of the project is (e.g. the location of the pyproject.toml file).

sdist object

Details of a source distribution file name for the package.

name string

The file name of the source distribution file name file.

upload-time

The time the file was uploaded (UTC). Must be specified as a datetime literal.

url string

The URL to the source tree.

path string

The path to the local directory of the source tree.

size integer

The size of the archive file.

hashes Record<string, string>

Known hash values of the file where the key is the hash algorithm and the value is the hash value.

wheels object[]

For recording the wheel files as specified by Binary distribution format for the package.

1.0 object
lock-version string required

Record the file format version that the file adheres to.

Values: "1.0"
created-by string required

Records the name of the tool used to create the lock file.

packages object[] required

An array containing all packages that may be installed.

environments string[]

A list of environment markers for which the lock file is considered compatible with.

requires-python string

Specifies the Requires-Python for the minimum Python version compatible for any environment supported by the lock file (i.e. the minimum viable Python version for the lock file).

extras string[]

The list of extras supported by this lock file.

Default:
[]
dependency-groups string[]

The list of dependency groups publicly supported by this lock file (i.e. dependency groups users are expected to be able to specify via a tool’s UI).

Default:
[]
default-groups string[]

The name of synthetic dependency groups to represent what should be installed by default (e.g. what project.dependencies implicitly represents).

Default:
[]
tool Record<string, object>

Similar usage as that of the [tool] table from the pyproject.toml specification, but at the package version level instead of at the lock file level (which is also available via [tool]).