При создании пакета Python в PyPI как указать путь к файлу readme

#python-3.x #pypi

Вопрос:

При создании моего пакета Python я задал имя файла для моего файла readme в файле setup.cfg под заголовком «long_description».:

 long_description = file: README.md

Это предполагает, что README.md файл находится в корневом каталоге проекта.
Как мне указать альтернативное местоположение?
Я безуспешно пытался:

 long_description = file: Docs/README.md

1. почему бы не поместить ваш README в самый внешний каталог? именно этого ожидают люди, открывая ваш пакет — вы даже можете направить их в раздел «Документы», если хотите иметь более подробную систему документации

Ответ №1:

Я бы посоветовал вам попробовать:

 long_description = open('your file').read()

1. Я думаю, что ваш ответ мог бы сработать, если бы я использовал setup.py файл, но я использую файл setup.cfg. Я все равно попробовал это в своем файле setup.cfg, и это не сработало.

Ответ №2:

Мне нужно было явно указать путь к моему файлу readme, создав MANIFEST.in файл в моем базовом каталоге с директивой, которая определяет местонахождение моего файла readme:

 include Docs/README.md

Подробности о MANIFEST.in файл и связанные с ним директивы находятся в https://packaging.python.org/guides/using-manifest-in/#using-manifest-in
Путь по-прежнему должен находиться под заголовком long_description в setup.cfg файле