Сборка дистрибутива пакета с помощью Poetry — Python: Настройка окружения

Когда ваш проект дорастёт до того состояния, когда им можно будет с кем-то поделиться, наступит время собрать код в дистрибутив, который уже не потребует poetry, чтобы запускать код. Конечно же, Poetry помогает и в этом деле!

Сборка и установка дистрибутива

Обычно poetry-проекты практически сразу пригодны к сборке их дистрибутивов. Какие-то особые случаи, требующие дополнительных действий по настройке, мы здесь рассматривать не будем — это достаточно редко бывает действительно нужно. Простой же проект вроде нашего примера можно собрать командой poetry build:

poetry build

Building hello (0.1.0)
  - Building sdist
  - Built hello-0.1.0.tar.gz
  - Building wheel
  - Built hello-0.1.0-py3-none-any.whl

После выполнения этой команды в "корне" проекта появится директория dist/ с двумя файлами, отличающимися расширениями. Нас сейчас интересует файл с расширением .whl, которое является сокращением от слова "wheel" ("колесо"). Так вот, этот файл уже пригоден к установке с помощью pip! Установим же его в "окружение пользователя":

python3 -m pip install --user dist/hello-0.1.0-py3-none-any.whl

Processing ./dist/hello-0.1.0-py3-none-any.whl
Installing collected packages: hello
Successfully installed hello-0.1.0

Если для проекта были описаны какие-то скрипты, то они будут доступны в виде команд. Как say-hello в случае нашего примера:

say-hello

Hello!

Установка пакета без сборки дистрибутива

Часто во время работы над кодом хочется попробовать проект в деле, минуя создание дистрибутива. Нет ничего проще: просто укажите путь до директории проекта в качестве имени пакета в команде pip install:

python3 -m pip install .

Processing /.../hello
  Installing build dependencies ... done
  Getting requirements to build wheel ... done
    Preparing wheel metadata ... done
Building wheels for collected packages: hello
  Building wheel for hello (PEP 517) ... done
  Created wheel for hello: filename=hello-0.1.0-py3-none-any.whl size=1671
...
Successfully built hello
Installing collected packages: hello
Successfully installed hello-0.1.0

say-hello

Hello!

Вы ведь помните, что "." означает текущую директорию?

Установка poetry-проектов из GitHub

Ранее в этом курсе уже упоминалась возможность установки с помощью Pip пакетов напрямую из GitHub. Так вот, эта возможность доступна и для poetry-проектов!

Однако стоит иметь в виду, что Pip относительно недавно научился понимать pyproject.toml. Поэтому держите ваш Pip свежим и периодически обновляйте с помощью команды pip install --user --upgrade pip

Самостоятельная работа

1. Соберите вашу версию проекта hello в .whl-файл. Установите его в пользовательское окружение. Проверьте, что команда say-hello работает без ошибок. Удалите установленный пакет (pip uninstall hello).
2. Установите ваш проект из директории. Проверьте, что скрипт работает и при таком сценарии установки. Удалите установленный пакет (pip uninstall hello).
3. Если вам вдруг захочется, можете выложить код проекта на ваш GitHub и попробовать установить его с помощью Pip прямо оттуда!

Остались вопросы? Задайте их в разделе «Обсуждение»

Вам ответят команда поддержки Хекслета или другие студенты.