Инструменты упаковки Python ожидают, что наш файл readme должен быть назван README или README.txt. Но если мы следуем этому соглашению, GitHub отображает его как простой текст на странице проекта, который не очень хорош. (в отличие от красивой версии HTML с именем README.rst)
Есть ли какой-либо метод, чтобы оба PyPI и GitHub были довольны README.
Вы можете использовать git фильтр, который при проверке должен взять ваш README.md (необходимый GitHub) и создать правильный README ( необходимо для Python, хотя Lennart Regebro answer предполагает, что PyPI не требует никакого файла README)
Итак, не учитывая тот факт, что PyPI не нуждается в README (и предупреждение можно просто проигнорировать), вот как вы могли (в общем) генерировать ожидаемый файл с Git:
Однако любую модификацию этого частного файла README нужно будет сообщать вручную в файл README.md (по крайней мере, из-за синтаксиса разметки, который не может угадать script)
Вот почему Нуфал Ибрагим ответ (который я сохранил) может быть более адаптирован, особенно если вы имеют доступ к символическим ссылкам (я все еще с Windows Xp на работе, поэтому мне не повезло):
Сделав README символической ссылкой на README.rst или, как Arto Bendiken, выполните следующие действия:
= > , имея README.rst символическую ссылку ro README.
git будет хранить символическую ссылку (и не файл, на который ссылается символическая ссылка), поэтому вы можете иметь как README, так и файл README.rst в ваш Git репо.
PyPI не требует, чтобы этот файл назывался README или README.txt, поэтому просто назовите его README.rst. Фактически, PyPI не будет, насколько мне известно, смотреть в вашем пакете вообще (хотя я мог ошибаться там, я не изучал код или что-то еще), текст, который заканчивается на передней панели, это long_description.
Затем в вашем setup.py вы сделаете что-то вроде этого:
setup(name='Your module name',
version="1.0",
description="Whatever, dude.",
long_description=open('docs/README.rst', 'rt').read()
)
Грубый способ, который я могу представить, - сделать символическую ссылку на README, называемую README.rst, и проверить их оба.
Цитирование Éric Araujo на Ошибка Python о предупреждении distutils:
В упаковке /distutils 2 рекомендуемая идиома выглядит так (в setup.cfg):
[metadata] description-file = README.whateversdist будет включать этот файл. Вы также можете написать описание в setup.cfg напрямую и добавить свой файл README в поле extra_files.
Итак, в основном, игнорируйте предупреждение из distutils об отсутствии README.txt. Кроме того, distutils2 предположительно не выдает это предупреждение (я не тестировал), поэтому вы можете попробовать обновить.
В более старых (не distutils2) настройках вы можете явно добавить свой README.rst в файл MANIFEST.in. Вы по-прежнему будете видеть предупреждение о том, что стандартный README {.txt} отсутствует, но ваш README.rst будет включен в ваш sdist tarball, то есть он будет включен для конечных пользователей, которые загружаются непосредственно из PIPY.
Подробнее см. http://docs.python.org/2/distutils/sourcedist.html#the-manifest-in-template.