Python y VSCode: una guía completa y ordenada para la configuración de proyectos

Instale Python (si aún no lo ha hecho): descargue e instale Python desde el sitio web oficial: https://www.python.org/downloads/

Instale Visual Studio Code (VSCode): descargue e instale VSCode desde el sitio web oficial: https://code.visualstudio.com/download

Abra VSCode e instale la extensión Python de Microsoft. Esto le proporcionará funciones como IntelliSense, linting, depuración, etc. Para instalar la extensión, vaya a la vista Extensiones haciendo clic en el icono cuadrado en la barra lateral izquierda o presionando Ctrl+Shift+Xbusque «Python» y haga clic en «Instalar» en el primer resultado.

Cree una nueva carpeta para su proyecto: en VSCode, vaya a Archivo > Abrir carpeta y cree una nueva carpeta para su proyecto. Seleccione la nueva carpeta y haga clic en «Abrir».

Abra la terminal en VSCode: Vaya a Terminal > Nueva Terminal o presione Ctrl+` .

Cree un entorno virtual usando venv: en la terminal, ejecute el siguiente comando:

python -m venv ven

Esto creará un entorno virtual llamado «venv» en su carpeta de proyecto.

7. Activa el entorno virtual: En la terminal, ejecuta el siguiente comando:

Para ventanas:

.venvScriptsactivate

Para mac OS/Linux:

source venv/bin/activate

8. Inicialice un repositorio de Git: en la terminal, ejecute el siguiente comando:

git init

Esto creará un nuevo repositorio de Git en la carpeta de su proyecto.

9. Cree un archivo .gitignore para ignorar archivos innecesarios: en VSCode, cree un nuevo archivo llamado «.gitignore» en la raíz de la carpeta de su proyecto. Agrega el siguiente contenido:

__pycache__/
*.pyc
*.pyo
*.pyd
*.pyc
*.egg-info/
dist/
build/
*.egg
*.log
*.sql
*.sqlite
venv/

10. Prepare y confirme los cambios iniciales: en la terminal, ejecute los siguientes comandos:

git add .
git commit -m “Initial commit”

11. Cree un repositorio de GitHub: vaya a https://github.com/new y cree un nuevo repositorio. Puede dejar la opción «Inicializar este repositorio con un LÉAME» sin marcar ya que ya ha inicializado un repositorio Git localmente.

12. Vincule el repositorio local al repositorio remoto de GitHub: en la terminal, ejecute los siguientes comandos (reemplace <username> con tu nombre de usuario de GitHub y <repository_name> con el nombre de tu repositorio de GitHub):

git remote add origin git@github.com:<username>/<repository_name>.git

13. Configure las claves SSH para la autenticación (si aún no lo ha hecho): siga la guía de GitHub para generar una nueva clave SSH y agréguela a su cuenta de GitHub: https://docs.github.com/en/authentication/connecting- to-github-with-ssh/generando-una-nueva-clave-ssh-y-agregándola-al-agente-ssh

14. Envíe sus cambios al repositorio de GitHub: en la terminal, ejecute el siguiente comando:

git push -u origin master

Ahora que su proyecto está configurado, configuremos VSCode:

Configure el intérprete de Python (continuación): elija el intérprete ubicado en el entorno virtual de su proyecto (debe llamarse algo así como ./venv/bin/python o .venvScriptspython.exe). Esto creará un .vscode carpeta con un settings.json archivo en la carpeta de su proyecto. El settings.json El archivo debe contener una línea como esta:

“python.pythonPath”: “venv/bin/python”

2. Instale las herramientas de pelusa y formateo: en la terminal, ejecute el siguiente comando:

pip install pylint black

Esto instalará Pylint para pelusa y Black para formato de código.

3. Configure Pylint y Black en VSCode: abra la configuración en VSCode yendo a Archivo > Preferencias > Configuración, o presione Ctrl+,. Haga clic en el icono con corchetes {} en la esquina superior derecha para abrir la configuración de JSON. Agregue las siguientes líneas al archivo JSON:

“python.linting.pylintEnabled”: true,
“python.linting.enabled”: true,
“python.formatting.provider”: “black”,
“editor.formatOnSave”: true,

Esta configuración habilitará a Pylint para el linting, configurará Black como el formateador predeterminado y formateará el código al guardar un archivo.

4. (Opcional) Instale extensiones adicionales: es posible que desee instalar extensiones adicionales para mejorar su experiencia de desarrollo de Python en VSCode. Algunas extensiones populares incluyen:

Python Docstring Generator: genera automáticamente docstrings para sus funciones y clases de Python.

Explorador de pruebas de Python: proporciona una interfaz conveniente para ejecutar y depurar sus pruebas de Python.

GitLens: mejora las capacidades de Git de VSCode, proporcionando funciones como anotaciones de culpa, historial de líneas y más.

Para instalar estas extensiones, vaya a la vista Extensiones haciendo clic en el icono cuadrado en la barra lateral izquierda o presionando Ctrl+Shift+Xbusque la extensión deseada y haga clic en «Instalar».

5. (Opcional) Configuración de confirmación previa: la confirmación previa es una herramienta poderosa que lo ayuda a mantener un código limpio y consistente al ejecutar controles en su código antes de cada confirmación. Para usar la confirmación previa en su proyecto, siga estos pasos:

Instale la confirmación previa globalmente o dentro de su entorno virtual:

pip install pre-commit

En el directorio raíz de su proyecto, cree un nuevo archivo llamado .pre-commit-config.yaml.

Abra el archivo en su editor de texto y agregue una configuración básica previa a la confirmación. Aquí hay un ejemplo simple:

repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.0.1
hooks:
— id: trailing-whitespace
— id: check-ast
— id: check-yaml
— id: end-of-file-fixer

Guardar y cerrar el .pre-commit-config.yaml archivo.

Instale los ganchos de Git ejecutando el siguiente comando en su terminal:

pre-commit install

Si encuentra un error relacionado con core.hooksPathintente ejecutar:

pre-commit autoupdate

Este comando actualiza los ganchos a sus últimas versiones como se especifica en su .pre-commit-config.yaml archivo.

Ahora, cuando corres git commitla confirmación previa utilizará los ganchos especificados en el .pre-commit-config.yaml archivo. Si se detectan problemas, la confirmación se bloqueará hasta que los resuelva. Puedes personalizar tu .pre-commit-config.yaml archivo para incluir ganchos o repositorios adicionales según sea necesario.

6. ¡Disfruta! Ahora su proyecto de Python y VSCode están completamente configurados. Puede comenzar a crear su aplicación creando nuevos archivos de Python y escribiendo su código. Recuerde confirmar con frecuencia sus cambios en Git y enviarlos a su repositorio de GitHub. ¡Buena suerte con tu proyecto!