Python 201: Введение в distutils (Перевод)

В прошлый раз мы узнали как создавать модули и пакеты. Сегодня мы возьмём этот пакет и посмотрим, как при помощи distutils мы можем сделать этот пакет доступным для других людей. Мы научимся: 
  • создавать файл setup.py
  • создавать source distribution
  • создавать установщик для Windows

Начнём!

Пишем наш первый скрипт “setup.py”

Когда вы пишете ваш скрипт setup.py, Вы должны держать в голове его расположение. Если он будет находиться в папке с вашим пакетом, то это приведёт к ошибке при попытке им воспользоваться. Если он будет расположен где-то далеко, то скорее всего Вы при установке добавите ещё и те файлы, которые бы распространять не хотели. Поэтому для простоты мы создадим новую папку, куда и скопируем созданную вчера папку “mymath”. И тут же сохраним наш setup.py. Структура новой папки будет выглядеть так:
myNewFolder/
    mymath/
    setup.py
Внимание: Если у Вас нет кода, созданного в прошлой статье, его можно скачать тут

Теперь неплохо бы этот файл наполнить кодом:

from distutils.core import setup
 
setup(name = "mymath",
      version = "0.1",
      description = "A Simple Math Package",
      author = "Mike Driscoll",
      author_email = "mike@somedomain.com",
      url = "http://www.blog.pythonlibrary.org/2012/07/08/python-201-creating-modules-and-packages/",
      packages=["mymath"]
      )
Что же, выглядит не плохо. Если мы хотим добавить в наш setup.py ещё какие-то пакеты, то мы просто перечисляем их в списке packages. Кроме того есть список py_modules, куда можно добавить отдельные модули. Если Вы будете рыться в документации, то Вы обнаружите, что Вы можете добавлять даже файлы, не являющиеся скриптами Python используя класс Extension библиотеки distutils. Например, это может понадобиться для добавления файлов С или чего-то в этом роде, что можно встретить в сторонних пакетах, вроде lxml.

Distutils: Как распространять исходники и установщики для Windows

После того, как мы сохранили наш файл со скриптом, мы можем создать архив с исходниками, который будет использован для распространения нашего замечательного пакета. Откройте терминал (или командную строку в Windows) и перейдите в созданную вами папку. Затем выполните следующую команду

python setup.py sdist

Вы увидите что-то вроде этого:

C:UsersmdriscollDocumentsmymath-setup>python setup.py sdist
running sdist
warning: sdist: manifest template 'MANIFEST.in' does not exist (using default file list)
writing manifest file 'MANIFEST'
creating mymath-0.1
creating mymath-0.1mymath
copying files to mymath-0.1…
copying README.txt -> mymath-0.1
copying setup.py -> mymath-0.1
copying mymath__init__.py -> mymath-0.1mymath
copying mymathadd.py -> mymath-0.1mymath
copying myma
thdivide.py -> mymath-0.1mymath
copying mymathmultiply.py -> mymath-0.1mymath
copying mymathsubtract.py -> mymath-0.1mymath
creating dist
creating 'distmymath-0.1.zip' and adding 'mymath-0.1' to it
adding 'mymath-0.1PKG-INFO'
adding 'mymath-0.1README.txt'
adding 'mymath-0.1setup.py'
adding 'mymath-0.1mymathadd.py'
adding 'mymath-0.1mymathdivide.py'
adding 'mymath-0.1mymathmultiply.py'
adding 'mymath-0.1mymathsubtract.py'
adding 'mymath-0.1mymath__init__.py'
creating 'distmymath-0.1.zip' and adding 'mymath-0.1' to it
adding 'mymath-0.1PKG-INFO'
adding 'mymath-0.1README.txt'
adding 'mymath-0.1setup.py'
adding 'mymath-0.1mymathadd.py'
adding 'mymath-0.1mymathdivide.py'
adding 'mymath-0.1mymathmultiply.py'
adding 'mymath-0.1mymathsubtract.py'
adding 'mymath-0.1mymath__init__.py'
removing 'mymath-0.1' (and everything under it)

Что бы всё это могло значить? Только то, что distutils создал новую папку, названную dist, в которой теперь находится zip файл (mymath-0.1.zip) со всеми файлами вашего пакета. Если же Вы работаете на *nix — то получите tarball.
Далее, если Вы хотите создать установщик под Windows — это тоже будет легко сделать. Вам для этого понадобится такая команда:
python setup.py bdist_wininst

Эта  команда создаст папку build (на которую Вы можете не обращать внимание) и файл с названием mymath-0.1.win32.exe в вашей папке dist, который Вы можете запустить под Windows для установки вашего пакета. Так давайте попробуем!

Как установить ваш пакет?

В случае исходников, Вам надо их распаковать / разархивировать и затем выполнить следующую команду:
python setup.py install

Если всё было сделано верно и всё работает верно, то пакет будет установлен в вашей системе (для той версии python, которую Вы используете для запуска этой команды — прим. пер.). Если Вы запустите установщик Windows, то возникнет такой мастер установки:

Обратите внимание, что тут показаны все метаданные, которые мы указывали в нашем скрипте setup.py. Круто, правда? В любом случае, если Вы выполните все шаги мастера — Вы опять же установите пакет на свою систему.
Внимание: при такой установке пакет будет установлен в вашу основную версию Python. Если Вы не хотите этого — используйте virtualenv.

Итоги

Теперь Вы должны уметь создавать установщики и устанавливать свои пакеты при помощи distutils. Если Вы хотите загрузить ваш пакет в Python Packages Index (PyPI) — смотрите руководство. Удачи и кодируйте удовольствие!

Чтение на будущее

Источник

Автор: Ishayahu Lastov