From 3b91fe9e91eea4c2e4449d4e35e3b7294e5afd70 Mon Sep 17 00:00:00 2001 From: Sean McGinnis Date: Tue, 30 Oct 2018 11:01:36 -0500 Subject: [PATCH] Remove setup.py check from pep8 recommendations Using "python setup.py check -r -s" method of checking the package has been deprecated with the new recommendation to build the sdist and wheel, then running "twine check" against the output. Luckily, there is already a job that covers this that only runs when the README, setup.py, or setup.cfg files change, making running this in the pep8 job redundant. This is covered by the test-release-openstack-python3 that is defined in the publish-to-pypi-python3 template that nearly all repos use. More details can be found in this mailing list post: http://lists.openstack.org/pipermail/openstack-dev/2018-October/136136.html Change-Id: I7e6f090a63d3a8d4790426931797189251b38de7 Signed-off-by: Sean McGinnis --- doc/source/project-setup/python.rst | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/doc/source/project-setup/python.rst b/doc/source/project-setup/python.rst index 0abc83d..ca2b701 100644 --- a/doc/source/project-setup/python.rst +++ b/doc/source/project-setup/python.rst @@ -118,20 +118,6 @@ Just run:: $ tox -e pep8 -.. note:: - - For projects that publish their deliverables to PyPi, there are some extra - checks that are recommended for the RST formatting of the repo's README - file. In most cases, the repo's README file is used as the package - description on PyPi, and the upload of new packages to PyPi validate that - the description is valid RST. - - It is recommended that these projects add the following command to be run - under the pep8 tox target: - - python setup.py check --restructuredtext --strict - - Run One Test ^^^^^^^^^^^^