feat: add well-known legal files to build result automatically
Closed this issue · 2 comments
- I have searched the issues of this repo and believe that this is not a duplicate.
- I have searched the FAQ and general documentation and believe that my question is not already covered.
Feature Request
There are a handful of files that need to be added to builds result, for legal reasons.
This affects wheel and sdist builds.
The related files MUST be added to the package. the files MUST NOT install on the host system.
well-known legal files are:
LICENCE/LICENSE- obviouslyNOTICE- some license texts, like Apache-2.0, explicitly state this exact file (name) as a optional source of custom license addendumCOPYING- obviouslyAUTHORS- obviously
read also: https://wheel.readthedocs.io/en/stable/user_guide.html?#including-license-files-in-the-generated-wheel-file
They describe this already, and they also allow arbitrary file suffixes.
desired behavior
- all the well-known legal files are detected automatically, and are added to be build result.
- possibly arbitrary file suffixes are allowed
- added to
sdistroot - added to
wheel's.dist-infodirectory
- the bundled legal files are not "installed" during installation. they are not deflated into the
site-packages
current behavior
with poetry 1.6.1:
LICENSEis detectedNOTICEis not detectedCOPYINGis detected forwheelonlyAUTHORSis not detected
tried to add the needed files manually with include.
This will also cause the files to be installed into site-packages, which MUST NOT happen.
found a feature request to have the list of legal_files configurable, which made it never to public.
But this issue is not about configuration but about auto-detect, one like other packaging systems have.
this feature might need changes in https://github.com/python-poetry/poetry-core
This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.