Skip to content

Commit

Permalink
Merge pull request #1673 from konstin/konsti/scripts-are-files
Browse files Browse the repository at this point in the history
Clarify that the scripts directory is for files only
  • Loading branch information
ncoghlan authored Dec 8, 2024
2 parents 7576f94 + 40842ab commit 226afc2
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion source/specifications/binary-distribution-format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ its version, e.g. ``1.0.0``, consist of:
#. Python scripts must appear in ``scripts`` and begin with exactly
``b'#!python'`` in order to enjoy script wrapper generation and
``#!python`` rewriting at install time. They may have any or no
extension.
extension. The ``scripts`` directory may only contain regular files.
#. ``{distribution}-{version}.dist-info/METADATA`` is Metadata version 1.1
or greater format metadata.
#. ``{distribution}-{version}.dist-info/WHEEL`` is metadata about the archive
Expand Down Expand Up @@ -423,6 +423,10 @@ History
- February 2013: This specification was approved through :pep:`427`.
- February 2021: The rules on escaping in wheel filenames were revised, to bring
them into line with what popular tools actually do.
- December 2024: Clarified that the ``scripts`` folder should only contain
regular files (the expected behaviour of consuming tools when encountering
symlinks or subdirectories in this folder is not formally defined, and hence
may vary between tools).


Appendix
Expand Down

0 comments on commit 226afc2

Please sign in to comment.