Poetry: Comandos básicos para administrar tus proyectos Python

Poetry es una de esas cosas que te deberían de decir cuando empiezas con Python.

Antiguamente y en el afán de seguir buenas prácticas creaba mis entornos virtuales a la antigüita usando la herramienta venv que incluye el mismo Python y esta perfecto. Hasta que te das cuenta de que existe algo mejor.

Poetry es un gestor de dependencias de Python moderno y fácil de usar, diseñado para simplificar la administración de proyectos de Python.

Poetry utiliza un único archivo, pyproject.toml, para definir todas las configuraciones del proyecto, incluyendo las dependencias, scripts, etc. Esto simplifica la administración y evita la proliferación de archivos.

A mi me gusta porque es relativamente sencillo preparar un proyecto con Python en Linux y trasladarlo a un entorno Windows con muy pocas modificaciones.

Como es información que quiero tener a la mano y la documentación oficial es algo extensa les comparto una pequeña lista de los comandos más utilizados de Poetry.

Creación de un nuevo proyecto

poetry new mi_proyecto

Este comando crea un nuevo proyecto de Python llamado «mi_proyecto» con una estructura de archivos básica y un archivo pyproject.toml donde se configurarán las dependencias.

Agregar dependencias

poetry add requests

Este comando agrega la librería «requests» como dependencia a tu proyecto.

Para quitar dependencias

poetry remove requests

Este comando remueve la librería «requests» como dependencia a tu proyecto.

Actualizar dependencias

poetry update

Actualiza todas las dependencias a sus últimas versiones compatibles.

poetry update requests

Actualiza solo la dependencia «requests».

Instalar todas las dependencias

poetry install

Instala todas las dependencias listadas en el archivo pyproject.toml.

Mostrar las dependencias instaladas

poetry show

Muestra una lista detallada de todas las dependencias instaladas en el proyecto.

Ejecutar tu código

poetry run python mi_script.py

Ejecuta el script Python «mi_script.py» dentro del entorno virtual creado por Poetry.

Activar el entorno virtual

poetry shell

Activa el entorno virtual del proyecto. Una vez activado, puedes instalar y utilizar las dependencias de tu proyecto.

Exportar las dependencias

poetry export -f requirements.txt

Exporta las dependencias a un archivo requirements.txt compatible con pip.

Otros comandos útiles

poetry config: Permite configurar opciones globales de Poetry.
poetry remove: Elimina una dependencia del proyecto.
poetry lock: Genera un archivo poetry.lock que fija las versiones exactas de las dependencias para garantizar la reproducibilidad.

Ejemplo de un archivo pyproject.toml

[tool.poetry]
name = "mi_proyecto"
version = "0.1.0"
description = ""
authors = ["Tu Nombre <tu_email@example.com>"]

[tool.poetry.dependencies]
python = "^3.12"
requests = "^2.28"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

Poetry: Comandos básicos para administrar tus proyectos con Python