How to define "python_requires" in pyproject.toml using setuptools?

Question

Setuptools allows you to specify the minimum python version as such:

from setuptools import setup

[...]

setup(name="my_package_name",
      python_requires='>3.5.2',
      [...]

However, how can you do this with the pyproject.toml? The following two things did NOT work:

[project]
...
# ERROR: invalid key 
python_requires = ">=3"

# ERROR: no matching distribution found
dependencies = ["python>=3"]

Anderson Bravalheri · Accepted Answer · 2022-06-01 13:31:09Z

23

According to PEP 621, the equivalent field in the [project] table is requires-python.

The equivalent pyproject.toml of your example would be:

[project]
name = "my_package_name"
requires-python = ">3.5.2"
...

answered Jun 1, 2022 at 13:31

1,2299 silver badges9 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

This is documented packaging.python.org/en/latest/specifications/core-metadata/… but I didn't believe it wouldn't parse requires-python = "3.10" but checking with Ruff beta.ruff.rs/docs confirmed it wouldn't, and it doesn't like "=3.10" either, but "~=3.10" passes.

@NeilG I believe equality should be specified as ==3.10. packaging.python.org/en/latest/specifications/…

Thanks @JonathanHartley :facepalm: - that's why that didn't work then I guess.

cclauss · Accepted Answer · 2023-08-25 08:40:48Z

3

To force the use of an exact micro-version of CPython, use the syntax:

requires-python = ">=3.11.1,<3.11.2"

answered Aug 25, 2023 at 8:03

cclauss

77911 silver badges19 bronze badges

"==3.11.1" is simpler. See PEP 508 for the full spec for such strings.

You can find an up-to-date description of dependency specifiers here: packaging.python.org/en/latest/specifications/…