Как настроить исполнение pipenv

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

В этом руководстве мы рассмотрим, как настроить исполняемый файл pipenv на Windows. Мы также покажем, как добавить путь к этому файлу в переменную среды. Для пользователей macOS или Linux процесс настройки будет аналогичен.

Добавление файла Pipfile

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

Чтобы создать файл Pipfile, откройте терминал, перейдите в корневую директорию проекта и выполните команду:

pipenv install --python 3.8

Команда создает файл Pipfile и указывает, что проект использует Python версии 3.8. Можно заменить на другую версию Python, если нужно.

После выполнения команды в корневой директории проекта появится файл Pipfile, который можно открыть любым текстовым редактором.

Файл Pipfile содержит разделы: [packages] для зависимостей проекта и [dev-packages] для зависимостей разработки.

Пример файла Pipfile:

[[source]]
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"
[packages]
django = "==3.2.5"
requests = "*"
[dev-packages]
pytest = "*"

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

Установка и активация виртуального окружения

Для работы с проектом вам необходимо создать виртуальное окружение. Виртуальное окружение позволяет изолировать установленные пакеты и зависимости проекта от других системных пакетов.

При установке Pipenv он автоматически установит и активирует виртуальное окружение для вашего проекта. Если вы уже установили Pipenv, вы можете перейти к следующему шагу. В противном случае, вы можете установить Pipenv с помощью следующей команды:

pip install --user pipenv

После успешной установки Pipenv вы можете перейти в корневую директорию вашего проекта и создать виртуальное окружение с помощью следующей команды:

pipenv install

После установки нужно активировать виртуальное окружение. Для Windows:

pipenv shell

Для Linux/Mac:

pipenv shell

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

Добавление зависимостей в Pipfile

В Pipenv основные зависимости проекта отслеживаются в файле Pipfile. Чтобы добавить новую зависимость, выполните следующие шаги:

1. Откройте терминал или командную строку и перейдите в каталог проекта.
2. Выполните команду pipenv install имя_зависимости, где имя_зависимости - название необходимой библиотеки или пакета.
3. Пипенв автоматически обновит файл Pipfile и добавит новую зависимость в раздел [packages].

Пример таблицы с добавленными зависимостями в Pipfile:

После добавления зависимости можно использовать ее в проекте. Pipenv будет автоматически управлять версиями установленных пакетов, что обеспечивает надежность и согласованность работы проекта.

Установка зависимостей из Pipfile

Для установки зависимостей из Pipfile выполните следующие шаги:

1. Откройте командную строку или терминал в корневой папке проекта.
2. Активируйте виртуальную среду pipenv с помощью команды:

pipenv shell

3. Установите все зависимости, перечисленные в Pipfile, командой:

pipenv install

По умолчанию pipenv установит последние стабильные версии всех зависимостей, указанных в Pipfile. Он также создаст виртуальное окружение, если оно еще не было создано.

ВАЖНО: Если вы впервые устанавливаете зависимости для проекта, используйте команду pipenv install. Если же Pipfile.lock уже существует, и вы хотите установить зависимости, точно соответствующие версиям, указанным в Pipfile.lock, используйте команду pipenv sync. Это поможет воспроизводить ровно те же зависимости в вашей среде разработки и в продакшене.

После выполнения всех шагов вы успешно установите все зависимости из Pipfile и будете готовы к разработке вашего проекта с использованием pipenv.

Установка дополнительных пакетов

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

Чтобы установить дополнительный пакет с помощью pipenv, вы можете использовать команду pipenv install <имя_пакета>. Например, чтобы установить пакет requests, выполните следующую команду:

pipenv install requests

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

Если хотите установить определенную версию пакета, добавьте его явно. Например, для установки Flask версии 1.0.2 введите:

pipenv install Flask==1.0.2

Для удаления пакета используйте команду pipenv uninstall <имя_пакета>. Например, чтобы удалить requests, выполните:

pipenv uninstall requests

Управляйте зависимостями вашего проекта и поддерживайте его актуальным с помощью установки и удаления пакетов через Pipenv.

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

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

После активации виртуального окружения вы можете выполнять различные команды, такие как установка новых пакетов с помощью pip install или выполнение скриптов Python с помощью python. Все изменения, внесенные внутри виртуального окружения, будут сохранены только для данного проекта и не будут влиять на другие проекты.

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

После указания версий пакетов в файле Pipfile, выполните команду pipenv install для установки нужных пакетов с указанными версиями.

Примечание: Если не указана версия пакета, pipenv использует самую последнюю версию.

Обновление версий пакетов

При обновлении версий пакетов в проекте отредактируйте файл Pipfile и запустите команду pipenv update.

При выполнении этой команды pipenv будет проверять, возможно ли обновление пакета до новой версии, удовлетворяющей указанным ограничениям. Если обновление возможно, pipenv обновит пакет.

Если возникнут проблемы, pipenv поможет разрешить конфликты зависимостей.

Удаление виртуального окружения

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

Эта команда удалит виртуальное окружение и все его зависимости. Будьте осторожны: после удаления виртуального окружения восстановление его может быть затруднительным.

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

Использование Pipfile.lock

Когда вы работаете с проектом, необходимо использовать файл Pipfile.lock вместо Pipfile, чтобы гарантировать, что вы будете работать с одинаковым набором версий пакетов на всех устройствах и у ваших коллег.

Основные преимущества использования Pipfile.lock следующие:

• Гарантия однозначной версии пакета для всех разработчиков и серверов;
• Быстрое восстановление окружения с точно такими же версиями пакетов;
• Предотвращение проблем совместимости между пакетами.

Для установки всех пакетов из Pipfile.lock, выполните pipenv install --ignore-pipfile. Так вы загрузите все зависимости с фиксированными версиями.

Если вы вносили изменения в Pipfile, выполните pipenv lock для обновления Pipfile.lock с новыми версиями пакетов.

Использование Pipfile в других проектах

При создании нового проекта с использованием Pipenv, автоматически будет создан файл Pipfile с информацией о зависимостях проекта.

Если вы хотите использовать этот файл в другом проекте, скопируйте его в корневую директорию нового проекта. Затем запустите команду pipenv install для установки всех зависимостей, указанных в Pipfile, для нового проекта.

При установке также будет создан Pipfile.lock, содержащий точные версии всех установленных зависимостей. Важно скопировать и Pipfile, и Pipfile.lock в новый проект, чтобы сохранить точные версии зависимостей.

Если вы хотите импортировать зависимости из Pipfile в другой язык программирования, например, JavaScript с использованием npm, вы можете воспользоваться инструментом pipenv-requirements. Этот инструмент экспортирует зависимости из Pipfile в файл requirements.txt, который можно использовать в другом проекте.

Использование Pipfile в других проектах упрощает управление зависимостями и создание окружений между проектами. Обязательно установите верные версии зависимостей, указанные в Pipfile.lock, чтобы обеспечить совместимость и стабильность окружения вашего проекта.