jaraco / jaraco/skeleton

License injection has issues

Open
#178 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
150
Forks
38
Avg merge
1m
Merged PRs (30d)
1

Description

As articulated in pypa/setuptools#4981, there are some outstanding problems with the setuptools-based license injection.

- [ ] Injecting the license as a file leaves the file on the file system for the user to wonder why it's there. At the very least, this file should be omitted for local builds. Better would be to have a cleaner way to inject the license during sdist generation.
- [x] The license injection, including the network access, runs when building sdist to wheel, which is redundant and unnecessary. It's a larger problem for setuptools (there are many things that should probably be separated between sdist and wheel builds, but that's a separate issue). At the very least, the license retrieval should happen once for any source tree.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the problems and proposed context in pypa/setuptools#4981, then trace how this skeleton injects licenses during sdist and wheel builds. Confirm whether retrieval and file creation occur in both paths; done means avoiding redundant retrieval and preventing unwanted license files in local builds.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.