Instalar dependencias de desarrollo#

El contenido de este repositorio se convierte de archivos fuente escritos en Markdown hacia un sitio estático HTML que está hospedado en GitLab pages. Esto es posible gracias al software mkdocs que se puede ejecutar en el pipeline de CI/CD de GitLab o de manera local utilizando el Makefile que viene incluido en el sitio.

El repositorio también tiene un archivo de configuración del software pre-commit que nos ayuda a evitar los errores comunes cuando se envían archivos al repositorio de git.

Instalación git#

Necesitas tener la herramienta git instalada para hacer uso de los repositorios.

# apt install git

Note

Después de instalar git en el equipo, se debe realizar la configuración de la herramienta utilizando el comando git config como está descrito en la documentación.

Configuración de la identidad de usuario en git#

El programa git necesita conocer el nombre y dirección de correo de la persona que crea los commits.

$ git config --global user.name  "Andrés Hernández"
$ git config --global user.email "andres.hernandez@comunidad.unam.mx"

Verificar que la identidad del usuario se haya guardado en el archivo ~/.gitconfig.

$ cat ~/.gitconfig
[user]
    name = Andres Hernandez
    email = andres.hernandez@comunidad.unam.mx

Manejo de espacios en blanco en git#

$ git config --global core.whitespace blank-at-eol,blank-at-eof,space-before-tab

Configuración de caracteres de fin de línea en git#

GIT puede corregir los caracteres de fin de línea que utiliza Windows (CR-LF) para que sean compatibles con los de otros sistemas operativos más avanzados como GNU/Linux, macOS y BSD (LF).

GNU/Linux, macOS y BSD#

Si utilizas alguno de estos sistemas operativos, entonces basta con activar la opción para convertir CR-LF en LF en los archivos de entrada.

$ git config --global core.autocrlf input

Windows#

Cuando utilizas Windows, es necesario activar la conversión de CR-LF en LF en todos los casos.

$ git config --global core.autocrlf true

Instalación de make#

Es necesario instalar make para construir el sitio de manera local.

# apt install build-essential make tree

Instalación de dependencias de Python#

Los programas pre-commit y mkdocs están escritos en Python y son necesarias las dependencias de desarrollo para el manejador de paquetes de Python (pip3) para poder instalarlos en el sistema.

# apt install python3-dev python3-pip

Verifica que tengas pip3 instalado y actualizado.

$ which pip3
/usr/bin/pip3

$ pip3 install --user --upgrade pip
Requirement already satisfied: pip in /usr/lib/python3/dist-packages (20.3.4)
Collecting pip
  Downloading pip-23.0-py3-none-any.whl (2.1 MB)
Installing collected packages: pip
  WARNING: The scripts pip, pip3 and pip3.9 are installed in '/home/tonejito/.local/bin' which is not on PATH.
  Consider adding this directory to PATH or, if you prefer to suppress this warning, use --no-warn-script-location.
Successfully installed pip-23.0

Danger

  • Asegúrate de ejecutar pip3 y no pip
  • Nunca debes ejecutar pip3 con sudo

Agrega una ruta para alterar la variable de entorno PATH para tu usuario.

$ echo 'export PATH=${HOME}/.local/bin:${PATH}' >> ~/.bashrc

Note

  • Revisa que sólo tengas una vez la línea de export PATH en tu archivo ~/.bashrc

Warning

Debes de realizar alguna de las siguientes acciones después de modificar el archivo ~/.bashrc:

  • Ejecuta source ~/.bashrc en la terminal actual para incluir los cambios
  • Abre otra ventana de la terminal para que se lea el nuevo contenido del archivo ~/.bashrc
  • Cierra y abre tu sesión para que reconozca los cambios
  • Reinicia tu máquina

Instalación de pre-commit#

Instala pre-commit en tu perfil de usuario.

$ pip3 install --user pre-commit
Collecting pre-commit
    ...
Installing collected packages: ... pre-commit
    ...
Successfully installed ... pre-commit-2.20.0 ...

Danger

  • Asegúrate de ejecutar pip3 y no pip
  • Nunca debes ejecutar pip3 con sudo

Verifica que el shell reconozca la ubicación de pre-commit.

$ which pre-commit
/home/tonejito/.local/bin/pre-commit

Instalación de mkdocs#

Descarga el archivo requirements.txt de la página del curso.

$ wget -c -nv 'https://Redes-Ciencias-UNAM.gitlab.io/requirements.txt'

Se instala mkdocs para ejecutar el equivalente del pipeline de CI/CD de manera local.

$ pip3 install --user --requirement requirements.txt
Collecting mkdocs>=1.1.2
    ...
Installing collected packages: ... mkdocs ...
    ...
Successfully installed ... mkdocs-1.3.1 ...

Danger

  • Asegúrate de ejecutar pip3 y no pip
  • Nunca debes ejecutar pip3 con sudo

Verifica que el shell reconozca la ubicación de mkdocs.

$ which mkdocs
/home/tonejito/.local/bin/mkdocs

Note

⇦ ⇧ ⇨
Arriba Página siguiente