Skip to content

Commit 548ab34

Browse files
committed
Clarify that source distribution needs only package's files
Let's add some clarification to the "complete source distribution" part to make it clear that we're talking only of package's files, and not requiring people to vendor all the dependencies.
1 parent 6f55709 commit 548ab34

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

source/discussions/downstream-packaging.rst

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -94,10 +94,19 @@ a few important reasons to provide a static archive file instead:
9494
How?
9595
~~~~
9696

97-
Ideally, **a source distribution archive should include all the files**
98-
necessary to build the package itself, run its test suite, build and install
99-
its documentation, and any other files that may be useful to end users, such as
100-
shell completions, editor support files, and so on.
97+
Ideally, **a source distribution archive should include all the files
98+
from the package's Git repository** that are necessary to build the package
99+
itself, run its test suite, build and install its documentation, and any other
100+
files that may be useful to end users, such as shell completions, editor
101+
support files, and so on.
102+
103+
This point applies only to the files belonging to the package itself.
104+
The downstream packaging process, much like Python package managers, will
105+
provision the necessary Python dependencies, system tools and external
106+
libraries that are needed by your package and its build scripts. However,
107+
the files listing these dependencies (for example, ``requirements*.txt`` files)
108+
should also be included, to help downstreams determine the needed dependencies,
109+
and check for changes in them.
101110

102111
Some projects are concerned about increasing the size of source distributions,
103112
or do not wish Python packaging tools to fall back to source distributions

0 commit comments

Comments
 (0)