Skip to content
The Chat Archive
o1-mini-2024-09-12· OpenAI WildChat-4.8M (AI2)

crea un plan de accion para implementar poetry, en un repositorio en azuredevops y…

  1. User

    crea un plan de accion para implementar poetry, en un repositorio en azuredevops y agregar todas las buenas practicas posibles como flake8 y mas. Debe fijarse el escenario en el que el repositorio ya ha sido creado y tiene distintas ramas, y el escenario en que se empieza desde 0. Adicional se debe crear un manual para todo, para hacer deployments pushes, todo lo que sea necesario.

  2. Assistant

    Plan de Acción para Implementar Poetry en un Repositorio de Azure DevOps

    Este plan de acción abarca dos escenarios:

    1. Repositorio ya existente con múltiples ramas.
    2. Repositorio nuevo desde cero.

    Además, incluye la integración de buenas prácticas como flake8 y la creación de un manual para manejar deployments, pushes y otros procesos necesarios.


    Índice

    1. 1. Preparativos Iniciales
    2. 2. Implementación de Poetry en un Repositorio Existente
    3. 3. Implementación de Poetry en un Repositorio Nuevo
    4. 4. Manual de Uso
    5. 5. Buenas Prácticas Adicionales
    6. 6. Conclusión

    1. Preparativos Iniciales

    Antes de comenzar, asegúrate de tener lo siguiente:

    • Acceso a Azure DevOps: Permisos adecuados para modificar el repositorio y configurar pipelines.
    • Instalación de Poetry: Asegúrate de que Poetry esté instalado en tu máquina local. Puedes instalarlo siguiendo las instrucciones en Poetry Oficial.
    • Conocimiento Básico de Git y Azure Pipelines: Familiarízate con conceptos básicos de Git y la configuración de pipelines en Azure DevOps.
    • Editor de Código Configurado: Un editor como VSCode con extensiones para Python, flake8, etc.

    2. Implementación de Poetry en un Repositorio Existente

    2.1. Clonar el Repositorio

    1. Clona el repositorio existente:

      git clone https://dev.azure.com/tu_organización/tu_proyecto/_git/tu_repositorio
      cd tu_repositorio
      

    2.2. Configurar Poetry

    1. Inicializa Poetry en el proyecto:

      poetry init
      
      • Sigue las indicaciones para configurar el pyproject.toml.
      • Especifica las dependencias necesarias.
    2. Instala las dependencias:

      poetry install
      
    3. Activar el entorno virtual de Poetry:

      poetry shell
      
    4. Actualizar el repositorio con los cambios:

      git add pyproject.toml poetry.lock
      git commit -m "Configuración inicial de Poetry"
      git push origin main
      

    2.3. Añadir y Configurar Flake8 y Otras Herramientas

    1. Añadir flake8 como dependencia de desarrollo:

      poetry add --dev flake8
      
    2. Configurar flake8:

      Crea un archivo .flake8 en la raíz del proyecto:

      [flake8]
      max-line-length = 88
      extend-ignore = E203, W503
      exclude = .git,__pycache__,docs/source/conf.py,old,build,dist
      
    3. Añadir otras herramientas si es necesario: Por ejemplo, black, mypy, etc.

      poetry add --dev black mypy
      
    4. Actualizar pyproject.toml si es necesario para configurar estas herramientas.

    2.4. Configurar Azure Pipelines

    1. Crear un archivo de pipeline: Crea un archivo azure-pipelines.yml en la raíz del repositorio.

      trigger:
        branches:
          include:
            - main
            - develop
            - feature/*
      
      pool:
        vmImage: 'ubuntu-latest'
      
      steps:
        - task: UsePythonVersion@0
          inputs:
            versionSpec: '3.x'
            addToPath: true
      
        - script: |
            curl -sSL https://install.python-poetry.org | python3 -
            echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
            source ~/.bashrc
            poetry install
          displayName: 'Instalar Poetry y dependencias'
      
        - script: |
            poetry run flake8
          displayName: 'Ejecutar flake8'
      
        - script: |
            poetry run black --check .
          displayName: 'Verificar formato con Black'
      
        - script: |
            poetry run mypy .
          displayName: 'Ejecutar mypy'
      
    2. Configurar el pipeline en Azure DevOps:

      • Ve a Pipelines en tu proyecto de Azure DevOps.
      • Crea un nuevo pipeline y selecciona el repositorio.
      • Azure DevOps detectará automáticamente el archivo azure-pipelines.yml.
      • Revisa y ejecuta el pipeline.

    2.5. Integrar Pre-commit Hooks

    1. Añadir pre-commit a las dependencias de desarrollo:

      poetry add --dev pre-commit
      
    2. Crear el archivo de configuración .pre-commit-config.yaml:

      repos:
        - repo: https://github.com/pre-commit/mirrors-flake8
          rev: v4.0.1
          hooks:
            - id: flake8
        - repo: https://github.com/psf/black
          rev: 23.1.0
          hooks:
            - id: black
            language_version: python3
        - repo: https://github.com/pre-commit/mirrors-mypy
          rev: v0.991
          hooks:
            - id: mypy
      
    3. Instalar los hooks de pre-commit:

      poetry run pre-commit install
      
    4. Agregar y comprometer los cambios:

      git add .pre-commit-config.yaml
      git commit -m "Añadir pre-commit hooks"
      git push origin main
      

    2.6. Actualizar las Ramas Existentes

    1. Repetir los pasos anteriores en cada rama o fusionar main con las ramas existentes para propagar la configuración.

    2. Verificar que los pipelines funcionan correctamente en todas las ramas.


    3. Implementación de Poetry en un Repositorio Nuevo

    3.1. Crear el Repositorio en Azure DevOps

    1. Crear un nuevo repositorio:

      • Accede a Azure DevOps.

      • Navega a Repos y crea un nuevo repositorio.

      • Clona el repositorio en tu máquina local.

        git clone https://dev.azure.com/tu_organización/tu_proyecto/_git/tu_repositorio
        cd tu_repositorio
        

    3.2. Inicializar Poetry

    1. Inicializar Poetry:

      poetry init
      
    2. Instalar dependencias:

      poetry install
      
    3. Crear estructura básica del proyecto:

      mkdir src tests
      touch src/__init__.py tests/__init__.py
      
    4. Hacer el primer commit:

      git add .
      git commit -m "Inicializar proyecto con Poetry"
      git push origin main
      

    3.3. Añadir y Configurar Flake8 y Otras Herramientas

    1. Añadir flake8 y otras herramientas como se describió en la sección 2.3.

    2. Configurar los archivos de configuración correspondientes (.flake8, pyproject.toml, etc.).

    3.4. Configurar Azure Pipelines

    1. Crear el archivo azure-pipelines.yml con la configuración mencionada en la sección 2.4.

    2. Configurar el pipeline en Azure DevOps siguiendo los mismos pasos.

    3.5. Integrar Pre-commit Hooks

    1. Añadir pre-commit y configurar como se detalló en la sección 2.5.

    2. Hacer commit y push de los archivos de configuración.


    4. Manual de Uso

    4.1. Configuración Inicial

    1. Clonar el Repositorio:

      git clone https://dev.azure.com/tu_organización/tu_proyecto/_git/tu_repositorio
      cd tu_repositorio
      
    2. Instalar Dependencias con Poetry:

      poetry install
      
    3. Activar el Entorno Virtual:

      poetry shell
      
    4. Instalar Hooks de Pre-commit:

      poetry run pre-commit install
      

    4.2. Flujo de Trabajo Diario

    1. Crear una Nueva Rama:

      git checkout -b feature/nueva-funcionalidad
      
    2. Desarrollar y Realizar Commits:

      • Escribe código siguiendo las convenciones establecidas.
      • Al hacer git commit, los hooks de pre-commit se ejecutarán automáticamente para verificar el código.
    3. Actualizar Dependencias:

      poetry update
      

    4.3. Push y Deployment

    1. Empujar Cambios al Repositorio Remoto:

      git add .
      git commit -m "Descripción de los cambios"
      git push origin feature/nueva-funcionalidad
      
    2. Crear un Pull Request:

      • Navega a Azure DevOps y crea un pull request desde tu rama hacia main o develop.
    3. Validación en el Pipeline:

      • Azure Pipelines ejecutará automáticamente las pruebas y revisiones de código configuradas.
      • Revisa los resultados del pipeline y resuelve cualquier problema si es necesario.
    4. Merge y Deployment:

      • Una vez aprobado, fusiona el pull request.
      • Dependiendo de la configuración del pipeline, se puede automatizar el deployment a entornos específicos.

    4.4. Mantenimiento y Mejores Prácticas

    1. Actualizar Dependencias Regularmente:

      poetry update
      
    2. Mantener el Código Limpio:

      • Ejecuta flake8, black, y mypy regularmente.
      • Resuelve cualquier advertencia o error detectado.
    3. Documentar Cambios:

      • Mantén un archivo CHANGELOG.md actualizado con los cambios realizados.
    4. Revisar y Mejorar Configuraciones:

      • Revisa periódicamente las configuraciones de pyproject.toml, pipelines y pre-commit hooks para asegurar que estén actualizadas y optimizadas.

    5. Buenas Prácticas Adicionales

    • Versionado Semántico: Utiliza versionado semántico para gestionar las versiones del proyecto.
    • Documentación: Mantén una documentación clara y actualizada, preferiblemente en un directorio /docs.
    • Pruebas Automatizadas: Integra pruebas unitarias y de integración en el pipeline.
    • Revisiones de Código: Implementa reglas para revisiones de código antes de fusionar cambios.
    • Seguridad: Escanea dependencias en busca de vulnerabilidades utilizando herramientas como safety o bandit.

    6. Conclusión

    Implementar Poetry en un repositorio de Azure DevOps, ya sea existente o nuevo, junto con la integración de buenas prácticas como flake8, mejora significativamente la gestión de dependencias, la calidad del código y la eficiencia del proceso de desarrollo. Siguiendo este plan de acción y manual de uso, se asegura una configuración robusta y mantenible que facilita el trabajo en equipo y la entrega continua de software de alta calidad.


    Recursos Adicionales: