pypa / pypa/setuptools

Integrate functionality from check-manifest

Open
#57 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement minor Needs Triage
Dominant language
Python
Stars
2.9k
Forks
1.4k
Avg merge
1d 1h
Merged PRs (30d)
1

Description

Originally reported by: freakboy3742 (Bitbucket: freakboy3742, GitHub: freakboy3742)


A common problem with Python packaging is creating and maintaining an accurate MANIFEST/MANIFEST.in file. It's easy to add a new submodule or piece of documentation, forget to include it in your MANIFEST, upload a release to PyPI, then have to issue a new point release to correct the problem.

check-manifest is a package that addresses this problem. If you run the command, it builds a source distribution and checks to see if there are files in the source directory that aren't in the package distribution; if there are missing files, it suggests MANIFEST.in rules that would correct the omission. It can also be used to generate an initial MANIFEST.in for a project.

In my opinion, check-manifest is sufficiently useful functionality that it warrants being part of setuptools itself.


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

No setuptools files, tests, or entry points are named. Start by reviewing check-manifest's documented behavior and the setuptools repository structure to identify where source-distribution manifest handling belongs. Done would require an agreed integration scope and equivalent checks or manifest generation within setuptools.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.