将安装脚本中的自述文件转换为使用pandoc重新构造的文本,以便在pypi上使用。
setuptools-readme的Python项目详细描述
将自述文件转换为带 Pandoc并对其进行消毒 皮皮。应该在安装脚本中使用。
# MANIFEST.in include README.rst include requirements.txt
# setup.pyimportioimportosimportsetuptoolsifany('dist'inxforxinsys.argv[1:])andos.path.isfile('README.md'):try:importsetuptools_readmeexceptImportError:print('Warning: README.rst could not be generated, setuptools_readme module missing.')else:setuptools_readme.convert('README.md',encoding='utf8')withio.open('README.rst',encoding='utf8')asfp:long_description=fp.read()
功能
- 如果pandoc未安装在您的系统上,则会自动下载它 (至~/下载)
- 从rest输出文件中删除.. raw:: html块(作为 中断pypi上的渲染)
- 如果MANIFEST.in不包含 include README.rst行
待办事项
在linux和macos上测试自动下载步骤。
版权所有©2018 Niklas Rosenstein