当前位置:  开发笔记 > 编程语言 > 正文

我怎样才能使这个long_description和README有几句不同?

如何解决《我怎样才能使这个long_description和README有几句不同?》经验,为你挑选了2个好方法。

对于我的一个软件包,我有一个README.rst文件,它被读入setup.py的长描述中,如下所示:

readme = open('README.rst', 'r')
README_TEXT = readme.read()
readme.close()

setup(
    ...
    long_description = README_TEXT,
    ....
    )

这样一来,我可以有README文件出现在我的github上页每一次我犯和时间的PyPI页每次我python setup.py register.只有一个问题.我想在github页面上说"这篇文档反映了envbuilder的预发布版本.对于最新版本,请参阅pypi."

我可以把这些行放在README.rst中并在我之前删除它们python setup.py register,但我知道在推到pypi之前我会忘记删除句子.

我正在尝试考虑自动化的最佳方法,所以我不必担心它.有人有主意吗?我可以做任何setuptools/distutils魔法吗?



1> Carl Meyer..:

您可以使用ReST注释和一些文本,例如"split here",然后在setup.py中将其拆分.Ian Bicking在带有index.txt和setup.py的 virtualenv中做到了这一点.



2> Ned Batcheld..:

另一种选择是通过添加适用于两种环境的段落来完全解决问题:"最新的不稳定代码在github上.最新的稳定工具包在pypi上."

毕竟,为什么假设pypi人不想被指向github?这对两个受众都更有帮助,并简化了setup.py.

推荐阅读
贾志军
这个屌丝很懒,什么也没留下!
DevBox开发工具箱 | 专业的在线开发工具网站    京公网安备 11010802040832号  |  京ICP备19059560号-6
Copyright © 1998 - 2020 DevBox.CN. All Rights Reserved devBox.cn 开发工具箱 版权所有