TurboGears / TurboGears/Ming

[packaging] ship tests with sdist, not with bdist

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

Nobody has claimed this yet.

Dominant language
Python
Stars
30
Forks
17
PR merge metrics
No merged PRs in 30d

Description

It's common practice to ship project's tests with sdist because it can contain files that are useful for development or build process (e.g. downstream packaging). But tests are useless for runtime and should not be included into bdist (wheel).

In case of setuptools build backend including/exclusion can be configured:
https://setuptools.pypa.io/en/latest/userguide/miscellaneous.html#controlling-files-in-the-distribution

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by reviewing the setuptools distribution-file configuration described in the linked documentation. Verify that project tests are present in the source distribution but absent from the built wheel; done means both artifact contents match that split.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.