setup.py → pyproject.toml

[DimitriPapadopoulos]

Configuring setuptools using pyproject.toml files

Plan migration from executable setup.py to declarative pyproject.toml:

1. Move to pyproject.toml and make setup.py a thin wrapper
2. Optionally use setuptools_scm to automate versioning

Nothing urgent here, just a suggestion to modify at some point.

[adrienverge]

1. Move to pyproject.toml and make setup.py a thin wrapper

+1, since this is the new standard.

[DimitriPapadopoulos]

Just keep in mind this is relatively new. Installing from source requires recent versions of pip and/or setuptools, more recent than bundled with Ubuntu 22.04 for example.

See for example codespell-project/codespell#2523.

[DimitriPapadopoulos]

Also, it might not be possible to share the following variables any more, between the setup process and the rest of the code, because setup now relies on a declarative pyproject.toml instead of the Python script setup.py. Will that necessarily result in duplication?

yamllint/yamllint/__init__.py

Lines 23 to 30 in c9c5e0b

	APP_NAME = 'yamllint'
	APP_VERSION = '1.28.0'
	APP_DESCRIPTION = __doc__
	__author__ = u'Adrien Vergé'
	__copyright__ = u'Copyright 2022, Adrien Vergé'
	__license__ = 'GPLv3'
	__version__ = APP_VERSION

[adrienverge]

Just keep in mind this is relatively new.

Sure. I don't think we should do the transition now.

Also, it might not be possible to share the following variables any more, [...] Will that necessarily result in duplication?

Well seen. I guess the new "right way to do" is to declare name, version, author, etc. in pyproject.toml, and fetch them from Python code using a setuptools helper?

[DimitriPapadopoulos]

Indeed, from Package Discovery and Resource Access using pkg_resources:

The pkg_resources module distributed with setuptools provides an API for Python libraries to access their resource files,

Also, for those installing from source, having up to date pip and setuptools is required any way. From Installing Packages:

While pip alone is sufficient to install from pre-built binary archives, up to date copies of the setuptools and wheel projects are useful to ensure you can also install from source archives:

python3 -m pip install --upgrade pip setuptools wheel

Therefore, my first remark about the need for recent versions is not considered to be an issue. Yet, my short experience is that the package documentation should remind this to end-users who attempt to install from source.

[DimitriPapadopoulos]

And a very long text with a funny introduction:
Why you shouldn't invoke setup.py directly

I realize that this article is quite long, and unfortunately this is the short version. [...] I hope that this article can be useful when you want to advocate against the use of setup.py: when you make a PR or a comment in a Slack channel, you can link to this Proustian monstrosity and hope that your audience pales before the prospect of reading through the whole thing and just assents to whatever you're asking them to do.

[barrelful]

@adrienverge now I started having an annoying warning from pip:

  DEPRECATION: yamllint is being installed using the legacy 'setup.py install' method, because it does not have a 'pyproject.toml' and the 'wheel' package is not installed. pip 23.1 will enforce this behaviour change. A possible replacement is to enable the '--use-pep517' option. Discussion can be found at https://github.com/pypa/pip/issues/8559

Maybe now it is a good time to transition? If you don't want to do it yourself, maybe I can make a PR.

[staticdev]

I am using pyproject.toml in all my professional projects and also all projects I maintain here on Github. It centralizes configs for the repo and has been working flawlessly for me in the past years.

[DimitriPapadopoulos]

The downside is that pyproject.toml often requires recent versions of pip, setuptools and wheel before installing from source. But then that's what the Python Packaging User Guide suggests any way.

I won't have time for a PR in the short term.

[staticdev]

@DimitriPapadopoulos you don't need.. it is already done #557

[ssbarnea]

@adrienverge Can we please make this a reality, it is a share to read:

DEPRECATION: yamllint is being installed using the legacy 'setup.py install' method, because it does not have a 'pyproject.toml' and the 'wheel' package is not installed. pip 23.1 will enforce this behaviour change. A possible replacement is to enable the '--use-pep517' option. Discussion can be found at https://github.com/pypa/pip/issues/8559

[adrienverge]

Sure, please see the ongoing discussion at #557.