Как упаковать примеры скриптов, используя дистрибутив?

Question

Я использую . Распространите, чтобы упаковать небольшую библиотеку python. Я создал структуру каталогов, как описано в the Hitchhiker's Guide to Packaging.

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

Answer 1

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

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

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

Answer 2

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