Регистрация пакета в Python Package Index

Home

Если вы напишете действительно полезный модуль, вполне естественно, что вы захотите поделиться им с другими людьми. Это одна из самых приятных сторон в разработке открытого программного обеспечения. К счастью, выгрузить пакет в Python Package Index (каталог пакетов Python) совсем несложно.

Этот процесс лишь немного отличается от процесса создания пакета. При этом следует обратить внимание на две вещи: не забыть включить описание в формате ReST (reStructuredText) в атрибут long_description и подставить значение download_url.

Несмотря на то, что формат ReST уже обсуждался ранее, мы должны здесь подчеркнуть, что применение формата ReST для оформления документации необходимо потому, что она будет преобразована в формат HTML после выгрузки пакета в Python Package Index. Вы можете воспользоваться инструментом ReSTless, созданным Аароном Хиллегас-сом (Aaron Hillegass), для предварительного просмотра форматированного текста, чтобы убедиться, что он отформатирован должным образом. Обязательно просматривайте документацию, чтобы убедиться в отсутствии нарушений форматирования. Если текст не будет должным образом отформатирован в формате ReST, после выгрузки модуля текст будет отображаться как обычный текст, а не как HTML.

В примере 9.2 приводится содержимое файла setup, py для инструмента командной строки и библиотеки, созданной Hoa (Noah).

Пример 9.2. Пример файла setup.py для выгрузки модуля в Python Package Index

С помощью этого файла setup.py теперь можно «автоматически» зарегистрировать пакет в Python Package Index, используя следующую команду:

В этом файле setup.py появились новые дополнительные поля, если сравнивать его с предыдущим примером symlinkator. В число дополнительных полей входят description, long_description, classifiers, author и download_url. Точка входа, обсуждавшаяся выше, позволяет запускать инструмент из командной строки и устанавливать его в каталог, по умолчанию предназначенный для сценариев.

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

В атрибут long_description записывается существующее описание, которое хранится в созданном нами файле index.txt в подкаталоге docs. Файл index.txt содержит текст в формате ReST, а сценарий setup.ру в процессе регистрации пакета в Python Package Index читает эту информацию и помещает ее в атрибут long_description.

Где можно получить дополнительную информацию ...

Ниже приводится несколько важных ресурсов: Easy install

http://peak.telecommunity.com/DevCenter/EasyInstall Пакеты Python в формате .egg

http://peak.telecommunity.com/DevCenter/PythonEggs Модуль setuptools

http://peak.telecommunity.com/DevCenter/setuptools Модуль pkg_resources

http://peak.telecommunity.com/DevCenter/PkgResources

Обзор архитектуры модуля pkg_resources и формата Python egg в общих чертах

И не забудьте про почтовую рассылку по языку Python http://mail.py-thon.org/pipermail/dlstutilssig/.

← Точки входа и сценарии консоли		Dlstutils →

Комментарии (0)

Написать комментарий

Советы по работе с Mandriva, Fedora и ASPLinux