Создайте и распределите свой собственный пакет Python

Все начинается с вопроса, как создать и эффективно распределить свои собственные Python-пакеты. В этом руководстве я покажу вам, как шаг за шагом разработать пакет, который вы сможете предложить другим. При этом крайне важно создать правильные файлы и обеспечить корректную структуру. Это позволит другим легко устанавливать и использовать ваш пакет. Давайте сразу начнем и исследуем основы распределения пакетов.

Основные выводы

1. Создайте файл setup.py, который будет содержать все метаданные вашего пакета.
2. Добавьте файл манифеста, который перечисляет все файлы, не относящиеся к Python.
3. Используйте правильную команду в терминале, чтобы создать вашу дистрибуцию.
4. Распакованный пакет можно легко передать для установки.

Пошаговая инструкция

Существуют некоторые ключевые шаги, которые необходимо выполнить, чтобы создать собственный Python-пакет. Ниже вы найдете подробное руководство с скриншотами, которое покажет вам путь к вашей собственной дистрибуции пакетов.

Создание структуры каталога

Сначала вам следует подготовить правильную структуру каталога для вашего пакета. Создайте главный каталог, который будет содержать все файлы и подкаталоги, включая исходный код, документацию и лицензионную информацию.

В этом примере я подготовлю простую структуру с файлом README.md и файлом лицензии. Вы можете использовать лицензию GPL, чтобы установить права на ваш пакет.

Определение структуры API

Чтобы ваш пакет был полезным, вам потребуется как минимум документация API и базовый класс, от которого могут наследоваться другие классы. Эта структура поможет в расширении и настройке вашего пакета.

Простой класс API и инвентаризации может стать отличной отправной точкой.

Создание файла setup.py

Центральный компонент вашего пакета — это файл setup.py. Здесь вы определяете все необходимые проектные данные, которые потребуются в процессе установки.

В этом файле вы импортируете необходимые модули и указываете основные детали вашего пакета, включая имя, автора, адрес электронной почты, номер версии и сайт.

Указание необходимых пакетов

Вы должны удостовериться, что все зависимости вашего пакета указаны. Это делается в файле setup.py, добавляя список пакетов, которые должны поставляться вместе с вашим пакетом.

Добавьте здесь все необходимые подпаки, такие как базовый класс и специфические обширные классы.

Создание файла манифеста

Чтобы убедиться, что все соответствующие файлы, не относящиеся к Python, включены в ваш пакет, создайте файл манифеста. Этот файл перечисляет все файлы, которые будут учтены при упаковке.

В этом файле вы указываете, какие типы файлов должны быть включены в пакет, а также такие директории, как документация.

Команды терминала для создания дистрибуции

Теперь пришло время создать пакет. Откройте терминал и перейдите в каталог вашего файла setup.py. Здесь вы можете выполнить команду для создания пакета.

Проверка созданных файлов

После создания дистрибуции вам следует найти каталог с именем dist, который содержит упакованный пакет.

Теперь вы можете передать этот файл или установить его.

Установка пакета

Чтобы убедиться, что пакет работает корректно, вы можете установить его снова. Для этого распакуйте каталог и снова выполните файл setup.py.

Для пользователей, у которых нет прав администратора, вы можете выполнить команду установки для текущего пользователя:

python setup.py install --user

Распределение для пользователей

Если вы хотите распространить ваш пакет, убедитесь, что все файлы, такие как README.md, лицензия и файл setup.py, включены. Это гарантирует, что пакет можно будет установить правильно, как только пользователь его загрузит.

Вот ваш пакет готов и может быть передан другим.

Резюме – Правильно упакуйте свои Python-пакеты

Теперь вы узнали, как создать всеобъемлющую структуру для своих Python-пакетов и успешно сгенерировать дистрибуцию, которую вы сможете легко распространить. От создания структуры каталога до установки конечным пользователем вы прошли все шаги, чтобы эффективно распределить ваш пакет.