logo

Cómo crear un archivo Requisitos.txt en Python

Si es desarrollador, sabrá que mientras trabaja en cualquier proyecto de Python o de ciencia de datos, es esencial trabajar siempre en un entorno que haga que su proyecto sea reutilizable y repetible sin crear un problema para cualquiera que retome su proyecto. Entonces, antes de analizar cómo crear un archivo .txt de requisitos en Python, háganos saber qué es require.txt y por qué lo necesitamos.

¿Qué es el archivo require.txt en Python?

En Pitón requisito.txt El archivo es un tipo de archivo que generalmente almacena información sobre todas las bibliotecas, módulos y paquetes que se utilizan durante el desarrollo de un proyecto en particular. También almacena todos los archivos y paquetes de los que ese proyecto depende o requiere ejecutarse. Normalmente, este archivo 'requirement.txt' se almacena (o reside) en el directorio raíz de sus proyectos. Aquí surge otra pregunta esencial de por qué necesitamos este tipo de archivos en nuestros proyectos.

¿Por qué necesitamos requisito.txt?

Nos ayuda de varias maneras, incluso cuando revisemos nuestro proyecto en el futuro, ya que resuelve casi todos los problemas de compatibilidad. Si alguna vez trabaja en algún proyecto de Python o desarrolla algún proyecto, seguramente sabrá que generalmente requerimos varios paquetes. Sin embargo, mientras desarrollamos un proyecto, generalmente utilizamos una versión particular de los paquetes. Más adelante, el administrador o mantenedor del paquete puede realizar algunos cambios, y estas modificaciones pueden dañar fácilmente toda la aplicación. Por lo tanto, es demasiado trabajo realizar un seguimiento de cada modificación en los paquetes. Específicamente, cuando el proyecto es demasiado grande, es esencial realizar un seguimiento de cada paquete que utilizamos para evitar sorpresas inesperadas.

Una de las formas estándar de resolver este tipo de problemas es utilizar un entorno virtual. La razón es que hay dos tipos principales de paquetes y ubicaciones donde normalmente se almacenan las bibliotecas de Python, y normalmente no necesitamos todos los tipos de estos paquetes mientras trabajamos en un proyecto en particular; por lo que se requiere saber cuál se requiere por proyecto para facilitar la reproducibilidad.

concatenar cadena java

Por lo general, involucra los siguientes archivos:

  • Paquetes de sistema que forman parte de la biblioteca estándar de Python
  • Paquetes de sitio (paquetes de terceros) que se instalan mediante pip.

¿Qué es un entorno virtual?

Un entorno virtual es un tipo de espacio de trabajo aislado o artificial que mantiene los paquetes del usuario separados de la instalación del sistema local (o principal). Nos permite crear un entorno aislado 'virtual' para cada proyecto de Python. Esto facilita que cada proyecto sea independiente del otro, especialmente cuando comparten las mismas dependencias. Hay varios paquetes disponibles que se pueden utilizar para crear un entorno virtual. Algunos de los paquetes básicos son los siguientes:

  • entorno virtual
  • pipenv

Entonces, una vez creado el entorno virtual para nuestro proyecto, veamos cómo instalar los paquetes y las bibliotecas. Es muy fácil obtener todos los paquetes necesarios que necesitamos usar en nuestro proyecto con el entorno virtual. Primero veamos cómo usar 'virtualenv'.

A. entorno virtual

Es un tipo de biblioteca que nos permite crear un entorno virtual y utilizarlo. Para instalar virtualenv, puede seguir las instrucciones proporcionadas:

1. Abra Cmd, escriba el siguiente comando y presione el botón Intro como se muestra en la imagen a continuación:

Dominio

 pip install virtualenv 

Producción

Cómo crear un archivo Requisitos.txt en Python

2. Creando el nuevo directorio de trabajo para el proyecto.

Ahora cree un nuevo entorno virtual dentro del directorio de ese proyecto para evitar problemas innecesarios.

Dominio

 Python3 -m venv name_of_env 

Producción

Cómo crear un archivo Requisitos.txt en Python

3. Ahora para utilizar este entorno virtual recién creado, sólo necesitamos activarlo. Para activar este entorno aislado, escriba el siguiente comando y presione el botón Intro como se muestra a continuación:

Dominio

 name_of_envirnmentScriptsactivate 

Producción

Cómo crear un archivo Requisitos.txt en Python

Para verificar que se haya creado nuestro nuevo entorno virtual, puede ver en el mensaje que el prefijo se cambia con el nombre de su nuevo entorno virtual, como en nuestro caso, hemos nombrado nuestro entorno virtual como 'nombre_de_envirnmnet'. También puedes verificarlo abriendo el directorio del proyecto o la carpeta donde se creará un nuevo directorio con el nombre especificado.

4. Ahora veamos cómo crear el archivo require.txt.

Para crear el archivo require.txt, será bueno saber qué contiene.

Los archivos require.txt incluyen todos los tipos de paquetes y bibliotecas estándar que se utilizan en ese proyecto en particular. Por lo tanto, este archivo require.txt juega un papel esencial en el desarrollo de proyectos pequeños o grandes. También nos ayuda a hacer que nuestros proyectos sean más portátiles.

Con la ayuda del archivo 'requirement.txt', se pueden evitar fácilmente varios problemas importantes. Para comprenderlo con más detalle, puede considerar el siguiente ejemplo:

Ejemplo:

Suponga que ha creado un nuevo proyecto, como una aplicación que es compatible con la versión específica de la biblioteca y los paquetes. Entonces, por alguna razón, reenvías esta solicitud a tu amigo.

Dado que no ha utilizado el archivo require.txt, es posible que su aplicación no se ejecute correctamente o incluso que no se inicie en el sistema de su amigo. La razón principal detrás de esto es que no todos los usuarios usan la misma versión de bibliotecas y paquetes. Sin embargo, si usó el archivo require.txt, cualquiera puede ejecutar y usar su proyecto o aplicación porque todos los paquetes y bibliotecas requeridos o usados ​​también se especifican en forma de archivo (requirement.txt) con su proyecto.

En este archivo .txt de requisitos, el usuario puede seleccionar, almacenar y mantener fácilmente los archivos necesarios según sus requisitos.

Cómo obtener el archivo Requisitos.txt: usando Virtualenv

Aquí podemos obtener el archivo requisitos.txt. Para crear el archivo require.txt, podemos usar el siguiente comando:

Dominio

 pip3 freeze > requirements.txt 

Producción

Cómo crear un archivo Requisitos.txt en Python

Cómo obtener el archivo Requisitos.txt: usando Pipenv

Pipenv también es una excelente herramienta de biblioteca de creación de entornos virtuales que tiene algunas características interesantes. Puede utilizar las siguientes instrucciones para obtener el archivo require.txt.

1. Escriba el siguiente comando para instalar pipenv

Dominio

 pip install pipenv 

Producción

Cómo crear un archivo Requisitos.txt en Python

2. Ahora escriba el siguiente comando y presione el botón Intro.

Dominio

 pipenv install mypackage 

El comando anterior se utiliza para instalar los paquetes necesarios para los proyectos.

Producción

Cómo crear un archivo Requisitos.txt en Python
  • Después de instalar los paquetes del proyecto, necesitamos activar el entorno virtual. Por lo tanto para activar el entorno virtual, puedes utilizar los siguientes comandos:

Dominio

 pipenv shell 

O

 pipenv run 

Estos comandos se pueden utilizar para activar el entorno virtual recién creado, como se muestra a continuación:

Producción

Cómo crear un archivo Requisitos.txt en Python

Ahora escriba el siguiente comando para ejecutar el script en el entorno virtual.

Dominio

 pipenv run Python myscript.py 

Explicación

Este comando se utiliza para ejecutar el script especificado en el entorno virtual como se muestra a continuación:

Producción

Cómo crear un archivo Requisitos.txt en Python

Como es más fácil, también realiza un seguimiento automático de todas las bibliotecas utilizadas para el proyecto en un archivo pip y un archivo pip. bloquear archivo. Estos archivos desempeñan la misma función que los requisitos.txt y también almacenan información adicional sobre varias cosas que no están incluidas en el requisito.txt.

Por lo tanto, puede utilizar este archivo pip como alternativa al archivo requisitos.txt. Sin embargo, si aún desea utilizar el archivo requisitos.txt, puede utilizar el siguiente comando:

 pipenv -r lock >> requirements.txt 

Producción

Cómo crear un archivo Requisitos.txt en Python

Cómo obtener el archivo Requisitos.txt: sin Virtualenv usando Pipreqs

Pipreqs es una de las herramientas más eficientes y sencillas de usar, que no requiere que cree ningún entorno virtual. Por lo tanto, es bastante útil si un usuario sólo requiere los paquetes y bibliotecas utilizados en una aplicación o proyecto.

Una de las cosas más importantes es que escanea automáticamente los scripts o archivos Python en busca de bibliotecas importadas y genera un archivo require.txt.

Veamos cómo funciona:

1. En primer lugar, debe instalar 'pipreqs', así que para descargarlo, escriba el siguiente comando en el cmd y presione el botón Intro:

Dominio

 pip install pipreqs 

Producción

Cómo crear un archivo Requisitos.txt en Python

2. Una vez que se completa la instalación, puede iniciar 'pipreqs' para obtener el archivo require.txt señalándolo a la ubicación donde se encuentra la carpeta de su proyecto.

Dominio

 pipreqs /path/to/project 

Producción

Cómo crear un archivo Requisitos.txt en Python

Para verificar que el archivo requirement.txt se haya creado correctamente, puede ver en la carpeta de su proyecto que se creará un nuevo archivo 'requirement.txt', como se muestra a continuación:

Cómo crear un archivo Requisitos.txt en Python