License injection has issues

Open
#178 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

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.

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.
  • 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.
Dominant language
No language data
Stars
152
Forks
38
Avg merge
6h 27m
Merged PRs (30d)
4

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from jaraco/skeleton

All issues in jaraco/skeleton

Similar issues

More Build System issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.