Re: [openstack-dev] [release] openstack-tox-validate: python setup.py check --restructuredtext --strict
On 06/06/2018 11:35 AM, Jeremy Stanley wrote: On 2018-06-06 18:24:00 +0200 (+0200), Dmitry Tantsur wrote: In Ironic world we run doc8 on README.rst as part of the pep8 job. Maybe we should make it a common practice? [...] First, the doc8 tool should be considered generally useful for any project with Sphinx-based documentation, regardless of whether it's a Python project. Second, doc8 isn't going to necessarily turn up the same errors as `python setup.py check --restructuredtext --strict` since the latter is focused on validating that the long description (which _might_ be in a file referenced from your documentation tree, but also might not!) for your Python package is suitable for rendering on PyPI. This is a good point about the README not necessarily being the long description. Another option for teams that have complicated README files that would be a lot of work to make compatible would be to explicitly set the long_description value for the project to something else: https://pythonhosted.org/an_example_pypi_project/setuptools.html __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [release] openstack-tox-validate: python setup.py check --restructuredtext --strict
On 2018-06-06 18:24:00 +0200 (+0200), Dmitry Tantsur wrote: > In Ironic world we run doc8 on README.rst as part of the pep8 job. > Maybe we should make it a common practice? [...] First, the doc8 tool should be considered generally useful for any project with Sphinx-based documentation, regardless of whether it's a Python project. Second, doc8 isn't going to necessarily turn up the same errors as `python setup.py check --restructuredtext --strict` since the latter is focused on validating that the long description (which _might_ be in a file referenced from your documentation tree, but also might not!) for your Python package is suitable for rendering on PyPI. -- Jeremy Stanley signature.asc Description: PGP signature __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [release] openstack-tox-validate: python setup.py check --restructuredtext --strict
Excerpts from Dmitry Tantsur's message of 2018-06-06 18:24:00 +0200: > In Ironic world we run doc8 on README.rst as part of the pep8 job. Maybe we > should make it a common practice? That seems like it may be a good thing to add, but I don't know that it is sufficient to detect all of the problems that prevent uploading packages because of the README formatting. > > On 06/06/2018 03:35 PM, Jeremy Stanley wrote: > > On 2018-06-06 16:36:45 +0900 (+0900), Akihiro Motoki wrote: > > [...] > >> In addition, unfortunately such checks are not run in project gate, > >> so there is no way to detect in advance. > >> I think we need a way to check this when a change is made > >> instead of detecting an error when a release patch is proposed. > > > > While I hate to suggest yet another Python PTI addition, for my > > personal projects I test every commit (essentially a check/gate > > pipeline job) with: > > > > python setup.py check --restructuredtext --strict > > python setup.py bdist_wheel sdist > > > > ...as proof that it hasn't broken sdist/wheel building nor regressed > > the description-file provided in my setup.cfg. My intent is to add > > other release artifact tests into the same set so that there are no > > surprises come release time. > > > > We sort of address this case in OpenStack projects by forcing sdist > > builds in our standard pep8 jobs, so maybe that would be a > > lower-overhead place to introduce the setup rst check? > > Brainstorming. > > > > > > > > __ > > OpenStack Development Mailing List (not for usage questions) > > Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe > > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev > > > __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [release] openstack-tox-validate: python setup.py check --restructuredtext --strict
In Ironic world we run doc8 on README.rst as part of the pep8 job. Maybe we should make it a common practice? On 06/06/2018 03:35 PM, Jeremy Stanley wrote: On 2018-06-06 16:36:45 +0900 (+0900), Akihiro Motoki wrote: [...] In addition, unfortunately such checks are not run in project gate, so there is no way to detect in advance. I think we need a way to check this when a change is made instead of detecting an error when a release patch is proposed. While I hate to suggest yet another Python PTI addition, for my personal projects I test every commit (essentially a check/gate pipeline job) with: python setup.py check --restructuredtext --strict python setup.py bdist_wheel sdist ...as proof that it hasn't broken sdist/wheel building nor regressed the description-file provided in my setup.cfg. My intent is to add other release artifact tests into the same set so that there are no surprises come release time. We sort of address this case in OpenStack projects by forcing sdist builds in our standard pep8 jobs, so maybe that would be a lower-overhead place to introduce the setup rst check? Brainstorming. __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [release] openstack-tox-validate: python setup.py check --restructuredtext --strict
On 2018-06-06 16:36:45 +0900 (+0900), Akihiro Motoki wrote: [...] > In addition, unfortunately such checks are not run in project gate, > so there is no way to detect in advance. > I think we need a way to check this when a change is made > instead of detecting an error when a release patch is proposed. While I hate to suggest yet another Python PTI addition, for my personal projects I test every commit (essentially a check/gate pipeline job) with: python setup.py check --restructuredtext --strict python setup.py bdist_wheel sdist ...as proof that it hasn't broken sdist/wheel building nor regressed the description-file provided in my setup.cfg. My intent is to add other release artifact tests into the same set so that there are no surprises come release time. We sort of address this case in OpenStack projects by forcing sdist builds in our standard pep8 jobs, so maybe that would be a lower-overhead place to introduce the setup rst check? Brainstorming. -- Jeremy Stanley signature.asc Description: PGP signature __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
