Как упаковать примеры скриптов с помощью дистрибутива?

Question

Я использую , распространяю для упаковки небольшой библиотеки Python.Я создал структуру каталогов, как описано в Руководстве автостопщика по упаковке .

Мой вопрос: где (в структуре каталогов) я размещаю примеры сценариев, которые показывают, как использовать библиотеку и чтонеобходимо внести изменения в setup.py?

Answer 1

Я думаю, что это хорошо, не устанавливать примеры, вместо этого вы можете сохранить папку examples в своем дистрибутиве, так что она может находиться на том же уровне, что и ваш setup.py,

Если вы хотите включить их, то включите в качестве отдельного модуля пакета, например 'example' - и этот каталог содержит все примеры сценариев, на которые пользователи могут ссылаться даже после установки.

package_data = {
        'module_1': [files],
        'module_2': [files],
        'example': [files],
}

Answer 2

Примеры сценариев являются типом документации, поэтому устанавливайте их так же, как и другие документы: as package_data .