Skip to content

Clarify that the scripts directory is for files only #1673

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 8, 2024
Merged

Clarify that the scripts directory is for files only #1673

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
38f9bfb
Clarify that the scripts directory is for files only
konstin Dec 6, 2024
40842ab
Add a History note about the clarification
ncoghlan Dec 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion source/specifications/binary-distribution-format.rst
View file
Open in desktop
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
Loading