Making a PyPI-friendly README


28.03.2020 — Про Python


Либу как и обещал, довёл до следующего релиза после полной документации, только вот установка через PyPi сломалась.

Во-первых я был удивлён достаточно быстрой реакцией сообщества, что не могут обновиться.

Во-вторых все пошли ставить либу через исходники (setup.py, LOL).

Я не мог представить даже чего так. Не хватало файла CHANGES.rst (склеиваю ридми и список изменений в лонг дескрипшен пакета). Думал, что раз ридми проходит, то и ченджлог должен. Оба же использую в setup.py через with open(), в метатеге description.

В общем скачал я два релиза с пупича, валид и инвалид. Начал сравнивать где жопа. Сразу бросилось в глаза то, что кто-то добавил в архив README.rst (ето точно не я, ведь все что хочу добавить я - указываю в файле MANIFEST.in).

Раз ето не я, значит кто-то захардкодил по именам файлов их добавление. Пошёл гуглить…

https://packaging.python.org/guides/making-a-pypi-friendly-readme/

Очень интуитивно-понятно. В итоге ридми добавляется само, а ченджлог в манифесте ✨

Недавние посты


© marshal.by 2020

Исходный код

Сайт работает на Gatsby + prismic и опубликован на GitHub.