setuptools icon indicating copy to clipboard operation
setuptools copied to clipboard

[Docs] Document license_file deprecation

Open mahmoud opened this issue 1 year ago • 1 comments

Summary

setuptools emits a warning about setup.cfg usage of license_file, encouraging a switch to license_files, and links to https://setuptools.pypa.io/en/latest/userguide/declarative_config.html

        ********************************************************************************
        The license_file parameter is deprecated, use license_files instead.

        This deprecation is overdue, please update your project and remove deprecated
        calls to avoid build errors in the future.

        See https://setuptools.pypa.io/en/latest/userguide/declarative_config.html for details.
        ********************************************************************************

But that link doesn't include any details on the deprecation.

OS / Environment

setuptools-68.2.2

Additional Information

Would be nice to see when the deprecation happened, a schedule for removal, etc. Maybe in the table on the linked docs page.

Code of Conduct

  • [X] I agree to follow the PSF Code of Conduct

mahmoud avatar Nov 30 '23 18:11 mahmoud

Hi @mahmoud thank you very much for opening the issue. Please feel free to open a PR with the suggestion or any doc updates. All the help with the docs is appreciated.

Prior to the due date for the deprecation the warning message would display a final date were the support ended. The fact that is not showing anymore is that this date is passed. It was initially introduced more than 2 years ago, ~23 May 2021.

abravalheri avatar Dec 05 '23 13:12 abravalheri