如何将图像添加到Python包索引文档?

时间:2016-01-27 13:44:10

标签: python setup.py pypi

我有一个模块存储库,其中包含模块代码,README.md文件以及存储在目录images/的README.md文件中使用的图像(使用相对链接链接到README.md中)。为了注册并将模块上传到PyPI,我有文件setup.pyMANIFEST.in。应该如何将图像包含在PyPI在线文档中(如假设页面https://pypi.python.org/pypi/junkmodule中所示)?

我目前的MANIFEST.insetup.py(并且不包括PyPI在线文档中的图片)如下:

MANIFEST.in

include LICENSE
include README.md
include images/*
include setup.py
include junkmodule.py

setup.py

#!/usr/bin/python
# -*- coding: utf-8 -*-

import os
import setuptools

def main():

    setuptools.setup(
        name             = "junkmodule",
        version          = "0.0.0.1",
        description      = "provides nothing much",
        long_description = Markdown_to_reStructuredText("README.md"),
        url              = "https://github.com/junkuser1/junkmodule",
        author           = "L. Ron. Hubbard",
        author_email     = "lrh@sern.ch",
        license          = "GPLv3",
        py_modules       = ["junkmodule"],
        entry_points     = """
            [console_scripts]
            junkmodule = junkmodule:junkmodule
        """
    )

def read(*paths):
    with open(os.path.join(*paths), "r") as filename:
        return filename.read()

def Markdown_to_reStructuredText(filename):
    try:
        import pypandoc
        return pypandoc.convert(filename, "rst")
    except:
        print("pypandoc not found; long description could be corrupted")
        return read(filename)

if __name__ == "__main__":
    main()

1 个答案:

答案 0 :(得分:0)

possible solution用于将图像托管在GitHub上,然后从README中获取图像。我已经在committhis result中对此进行了亲自测试。