Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add well-known legal files to build result automatically #8441

Closed
2 tasks done
jkowalleck opened this issue Sep 15, 2023 · 2 comments · Fixed by python-poetry/poetry-core#666
Closed
2 tasks done
Assignees
Labels
area/build-system Related to PEP 517 packaging (see poetry-core) area/core Related to the poetry-core library kind/feature Feature requests/implementations

Comments

@jkowalleck
Copy link

jkowalleck commented Sep 15, 2023

  • 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 - obviously
  • NOTICE - some license texts, like Apache-2.0, explicitly state this exact file (name) as a optional source of custom license addendum
  • COPYING - obviously
  • AUTHORS - 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 sdist root
    • added to wheel's .dist-info directory
  • the bundled legal files are not "installed" during installation. they are not deflated into the site-packages

current behavior

with poetry 1.6.1:

  • LICENSE is detected
  • NOTICE is not detected
  • COPYING is detected for wheel only
  • AUTHORS is 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.

@jkowalleck
Copy link
Author

this feature might need changes in https://github.com/python-poetry/poetry-core

@jkowalleck jkowalleck changed the title feat: add all known legal files to build result automatically feat: add well-known legal files to build result automatically Sep 15, 2023
@Secrus Secrus self-assigned this Nov 23, 2023
@radoering radoering added area/build-system Related to PEP 517 packaging (see poetry-core) area/core Related to the poetry-core library and removed status/triage This issue needs to be triaged labels Jan 2, 2024
Copy link

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 29, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area/build-system Related to PEP 517 packaging (see poetry-core) area/core Related to the poetry-core library kind/feature Feature requests/implementations
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants