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

This commit is contained in:
Ryan Gonzalez 2017-04-14 04:00:25 -05:00 committed by Victor Stinner
parent 947629916a
commit f9f87f0934
4 changed files with 19 additions and 5 deletions

View File

@ -95,8 +95,9 @@ source distribution:
distributions, but in the future there will be a standard for testing Python distributions, but in the future there will be a standard for testing Python
module distributions) module distributions)
* :file:`README.txt` (or :file:`README`), :file:`setup.py` (or whatever you * Any of the standard README files (:file:`README`, :file:`README.txt`,
called your setup script), and :file:`setup.cfg` or :file:`README.rst`), :file:`setup.py` (or whatever you called your setup
script), and :file:`setup.cfg`.
* all files that matches the ``package_data`` metadata. * all files that matches the ``package_data`` metadata.
See :ref:`distutils-installing-package-data`. See :ref:`distutils-installing-package-data`.
@ -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` :command:`sdist` will read a :file:`MANIFEST` file if no :file:`MANIFEST.in`
exists, like it used to do. 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 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 set of files to include or exclude from the source distribution. For an

View File

@ -95,6 +95,13 @@ New Modules
Improved 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 http.server
----------- -----------

View File

@ -96,7 +96,7 @@ class sdist(Command):
sub_commands = [('check', checking_metadata)] sub_commands = [('check', checking_metadata)]
READMES = 'README', 'README.txt' READMES = ('README', 'README.txt', 'README.rst')
def initialize_options(self): def initialize_options(self):
# 'template' and 'manifest' are, respectively, the names of # 'template' and 'manifest' are, respectively, the names of

View File

@ -10,6 +10,9 @@ What's New in Python 3.7.0 alpha 1?
Core and Builtins 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__(). - bpo-29914: Fixed default implementations of __reduce__ and __reduce_ex__().
object.__reduce__() no longer takes arguments, object.__reduce_ex__() now object.__reduce__() no longer takes arguments, object.__reduce_ex__() now
requires one argument. requires one argument.