Skip to content

bpo-11913: Add README.rst to the distutils standard READMEs #563

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
vstinner merged 1 commit into from
Apr 14, 2017
Merged

bpo-11913: Add README.rst to the distutils standard READMEs #563

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 6 additions & 2 deletions Doc/distutils/sourcedist.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,9 @@ source distribution:
distributions, but in the future there will be a standard for testing Python
module distributions)

* :file:`README.txt` (or :file:`README`), :file:`setup.py` (or whatever you
called your setup script), and :file:`setup.cfg`
* Any of the standard README files (:file:`README`, :file:`README.txt`,
or :file:`README.rst`), :file:`setup.py` (or whatever you called your setup
script), and :file:`setup.cfg`.
Copy link
Copy Markdown
Member

@vstinner vstinner Mar 9, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should document the change using a ".. versionchanged:: 3.7 xx" markup, see a few lines below.

Copy link
Copy Markdown
Member

@ned-deily ned-deily Mar 9, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, there should be an issue for this on bugs.python.org and the PR title should reference that issue. It looks like this is a duplicate of bpo-11913 which was originally closed as "wont fix". It could be reopened and used to track this.


* all files that matches the ``package_data`` metadata.
See :ref:`distutils-installing-package-data`.
Expand Down Expand Up @@ -130,6 +131,9 @@ described above does not apply in this case.
:command:`sdist` will read a :file:`MANIFEST` file if no :file:`MANIFEST.in`
exists, like it used to do.

.. versionchanged:: 3.7
:file:`README.rst` is now included in the list of distutils standard READMEs.


The manifest template has one command per line, where each command specifies a
set of files to include or exclude from the source distribution. For an
Expand Down
7 changes: 7 additions & 0 deletions Doc/whatsnew/3.7.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,13 @@ New Modules
Improved Modules
================

distutils
---------

README.rst is now included in the list of distutils standard READMEs and
therefore included in source distributions.
(Contributed by Ryan Gonzalez in :issue:`11913`.)

http.server
-----------

Expand Down
2 changes: 1 addition & 1 deletion Lib/distutils/command/sdist.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ def checking_metadata(self):

sub_commands = [('check', checking_metadata)]

READMES = 'README', 'README.txt'
READMES = ('README', 'README.txt', 'README.rst')

def initialize_options(self):
# 'template' and 'manifest' are, respectively, the names of
Expand Down
7 changes: 5 additions & 2 deletions Misc/NEWS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ What's New in Python 3.7.0 alpha 1?
Core and Builtins
-----------------

- bpo-11913: README.rst is now included in the list of distutils standard
READMEs and therefore included in source distributions.

- bpo-29914: Fixed default implementations of __reduce__ and __reduce_ex__().
object.__reduce__() no longer takes arguments, object.__reduce_ex__() now
requires one argument.
Expand Down Expand Up @@ -310,12 +313,12 @@ Library
- bpo-29694: Fixed race condition in pathlib mkdir with flags
parents=True. Patch by Armin Rigo.

- bpo-29692: Fixed arbitrary unchaining of RuntimeError exceptions in
- bpo-29692: Fixed arbitrary unchaining of RuntimeError exceptions in
contextlib.contextmanager.
Patch by Siddharth Velankar.

- bpo-26187: Test that sqlite3 trace callback is not called multiple
times when schema is changing. Indirectly fixed by switching to
times when schema is changing. Indirectly fixed by switching to
use sqlite3_prepare_v2() in bpo-9303. Patch by Aviv Palivoda.

- bpo-30017: Allowed calling the close() method of the zip entry writer object
Expand Down