odczytać plik README w pliku setup.py

Question

Tak więc chcę, aby plik long_description mojego skryptu instalacyjnego był plikiem z mojego pliku README.md. Ale kiedy to zrobię, instalacja dystrybucji źródłowej nie powiedzie się, ponieważ python setup.py sdist nie skopiuje pliku readme.

Czy istnieje sposób, aby distutils.core.setup() dołączyć plik README.md za pomocą polecenia sdist, aby instalacja nie zawiedzie?

Próbowałem trochę obejść, gdzie domyślnie do niektórych krótszy tekst, gdy plik README.md nie jest dostępny, ale rzeczywiście chcę, aby nie tylko PyPi pobiera zawartość pliku readme, ale także użytkownik, który instaluje pakiet.

Answer 1

Aby ręcznie zawierać pliki w dystrybucji wykonaj następujące czynności:

1. ustawić include_package_data = True

2. Utwórz plik MANIFEST.in że ma listę include <glob> linii dla każdego pliku chcesz dołączyć z główny projekt. Możesz użyć recursive-include <dirname> <glob>, aby dołączyć do podkatalogów katalogu głównego projektu.

Niestety dokumentacja do tego materiału jest bardzo rozdrobniony i rozłam w poprzek distutils Python, setuptools i stare dystrybuować dokumenty więc to może być trudne, aby dowiedzieć się, co trzeba zrobić.