Los elementos de un archivo requirements

Todos y cada uno de los ficheros de un programa tienen componentes elementales que hacen de un programa un objeto funcional. Por ejemplo, los elementos de un archivo requirements.txt para cualquier programa de código representan las dependencias o extenesiones necesarias para el funcionamiento del script.

Por eso mismo, en este post te traemos un glosario que define algunos elementos de un archivo requirements.txt para un programa que está buscando llamar a una API de una plataforma web que rastrea el movimiento de las criptomonedas en el mercado.

¿Qué es un archivo requirements.txt?

Un archivo requirements.txt es un documento utilizado en proyectos de Python para especificar las librerías y sus versiones necesarias para que el programa funcione correctamente. Este archivo es esencial para la instalación y gestión de dependencias, asegurando que todos los desarrolladores y entornos de despliegue tengan las mismas versiones de las librerías.

Formato y sintaxis de un archivo requirements.txt

El archivo requirements.txt sigue una sintaxis simple donde cada línea contiene el nombre de una librería seguido de su versión opcional. Ejemplos:

//Elementos de un archivo requirements
requests==2.25.1
urllib3>=1.26.5

Elementos de un archivo requirements

En otro artículo de KeepCoding, te hablamos sobre cómo funciona la plataforma web CoinAPI.io. Se trata de una plataforma que se encarga de rastrear el movimiento en el mercado de las criptomonedas. Esto lo comparten a través la creación de unas API (Interfaz de programación de aplicaciones) cuyo objetivo es comunicar plataformas o servidores web con otras aplicaciones.

En el desarrollo de este programa de código, proponemos dos ficheros que se encargan de almacenar los requerimientos del programa. Estos son los requirements.txt, para el funcionamiento del programa, y el fichero de requirements-dev.text, para el desarrollo fundamental del programa.

A continuación, te presentamos los elementos que componen cada uno de los dos ficheros del programa para CoinAPI. Estos son Elementos de un archivo requirements que se establecen en el principio del desarrollo del programa, hay algunos que serán eliminados o agregados en un paso posterior.

Archivo requirements.txt

Estos Elementos de un archivo requirements son dependencias que aparecerán, en un prinicipio, en el archivo requirements.text, pues son todas las librerías, con una versión concreta, para el desarrollo del programa.

• charset-normalizer: esta es una librería que se utiliza para codificar un texto y te permite leer un texto de mejor forma.
• idna: esta es un protocolo de Python que se encarga de controlar los dominios internacionalizados.
• requests: esta es la librería requests del lenguaje de programación Python. Se utiliza para trabajar con requests y responses.
• urllib: la librería urlib forma parte de las dependencias de Python que se utilizan para manejar los enlaces o URL que aparecen en un programa de código. Esta librería tiene 4 módulos y el primero de ellos, urllib.requests, es el que emplearás para intervenir los módulos de la librería requests.
  Este módulo se utiliza para abrir URL o enlaces, como el método urllib.requests.open.

Archivo requirements-dev.txt

El segundo fichero de programa de código almacena las librerías que el programador descarga y utiliza para el desarrollo del programa y sus dependencias:

• Autopep: es una librería de Python que puedes integrar en tus programas de código para formatear el código y encontrar de qué forma y en dónde se debe formatear el código.

De esta manera, ya puedes empezar a entender cómo emplear los archivos requirements.

Comparación entre requirements.txt y requirements-dev.txt

El archivo requirements.txt incluye las dependencias necesarias para ejecutar el programa en un entorno de producción. Por otro lado, requirements-dev.txt contiene librerías adicionales necesarias para el desarrollo, pruebas y otras tareas no relacionadas directamente con la ejecución del programa en produc

¿Cómo emplear los archivos requirements?

Ya que conoces los elementos de un archivo requirements, puedes crearlos y empezar a utilizarlos en el programa de código que estás reproduciendo. Para crear ambos ficheros, solo tienes que dirigirte a la herramienta de crear un nuevo folder de tu IDE dentro de un programa de código y nombrar el fichero.

• pip list: es un comando que se utiliza para conocer todas las dependencias que existen en los programas y, por lo tanto, en el fichero de requerimientos del mismo.
• pip install – r: es un comando que se ingresa en la consola y se utiliza para instalar el archivo requirements.txt desde pip.
• Para ejecutar ambos ficheros, deberás agregar el fichero txt en el fichero –dev.txt. Esto lo haces utilizando el comando anterior de la siguiente manera: -r.requirements.txt.
• Las dependencias de cada uno de los ficheros siempre deben estar organizadas por orden alfabético.

¿Cuál es el siguiente paso?

Si bien ya te hemos presentado un glosario con los elementos de un archivo requirements.txt para un programa que busca enlazar la API de una plataforma web con otras aplicaciones, aún te queda la oportunidad de emplear todos estos conocimientos y reproducirlos en tus programas de código.

Por tanto, si quieres seguir profundizando en estos conocimientos DevOps y realizando más ejercicios prácticos, te recomendamos matricularte en el programa Bootcamp en DevOps & Cloud computing. Es un camino muy certero para convertirte en desarrollador DevOps en menos de un año. ¡Anímate a apuntarte ahora para seguir escribiendo código!