Compartir a través de

Información general sobre las plantillas de azd web de Python

  • Artículo

Las plantillas de la CLI para desarrolladores de Azure web de Python (azd) son la manera más rápida y sencilla de empezar a compilar e implementar aplicaciones web de Python en Azure. En este artículo se proporciona información contextual en segundo plano a medida que se está iniciando.

La mejor manera de empezar es seguir el inicio rápido para crear su primera aplicación web de Python e implementarla en Azure en cuestión de minutos con azd plantillas. Si no desea configurar un entorno de desarrollo local, puede seguir el inicio rápido con GitHub Codespaces en su lugar.

¿Cuáles son las plantillas de azd web de Python?

Hay muchas azd plantillas disponibles en la galería Awesome AZD Templates. Sin embargo, esta colección de plantillas web azd de Python es única, ya que proporcionan una aplicación web de ejemplo con paridad de características en muchas combinaciones populares de recursos de Azure y marcos web de Python.

Al ejecutar una plantilla web azd de Python, hará lo siguiente:

  • Crear una aplicación de inicio: específicamente, un sitio web para una empresa ficticia denominada Relecloud. El código del proyecto presenta muchos procedimientos recomendados para los marcos y paquetes de Python especificados que son necesarios para esa pila concreta de tecnologías. La plantilla está pensada para ser un punto de partida para la aplicación. Agregue o quite la lógica de la aplicación y los recursos de Azure según sea necesario.
  • Aprovisionamiento de recursos de Azure: la plantilla aprovisiona recursos de Azure para hospedar la aplicación web y la base de datos mediante Bicep, una conocida herramienta de infraestructura como código. De nuevo, modifique las plantillas de Bicep si necesita agregar más servicios de Azure.
  • Implementación de la aplicación de inicio en los recursos de Azure recién aprovisionados: la aplicación de inicio se implementa automáticamente para que pueda verlo todo en cuestión de minutos y decidir lo que desea modificar.
  • Opcional: Configure un repositorio de GitHub y una canalización de CI/CD: si lo desea, la plantilla contiene la lógica para configurar un repositorio de GitHub para usted, incluida una canalización de CI/CD de Acciones de GitHub. En cuestión de minutos, puede realizar cambios en el código del proyecto web. Al combinar esos cambios en la rama principal del repositorio de GitHub, la canalización de CI/CD las publica en el nuevo entorno de hospedaje de Azure.

¿A quién va dirigida esta característica?

Las plantillas están diseñadas para que las usen desarrolladores web de Python experimentados que quieran empezar a crear una nueva aplicación web de Python destinada a la implementación de Azure.

¿Por qué querría usar esto?

El uso de las azd plantillas proporciona varias ventajas:

  • Inicio más rápido posible : con el entorno de desarrollo local y las configuraciones del entorno de hospedaje fuera del camino, puede centrarse en compilar la aplicación en cuestión de minutos.
  • Inicio más sencillo posible : ejecute solo algunas instrucciones de línea de comandos para crear un entorno de desarrollo, hospedaje e implementación local completo. El flujo de trabajo es fácil de usar y fácil de recordar.
  • Creación de procedimientos recomendados : cada plantilla se crea y mantiene mediante Python en veteranos del sector de Azure. Agregue el código siguiendo sus enfoques de diseño para basarse en una base sólida.

Índice de plantillas

En la tabla siguiente se enumeran los monikers de plantilla web azd de Python disponibles para usarlos con el azd init comando , las tecnologías implementadas en cada plantilla y un vínculo al repositorio de GitHub si desea contribuir a los cambios.

Plantilla Marco web Base de datos Plataforma de hospedaje Repositorio de GitHub
azure-django-postgres-flexible-aca Django Servidor flexible de PostgreSQL Azure Container Apps repo
azure-django-postgres-flexible-appservice Django Servidor flexible de PostgreSQL Azure App Service repo
azure-django-cosmos-postgres-aca Django Cosmos DB (adaptador de PostgreSQL) Azure Container Apps repo
azure-django-cosmos-postgres-appservice Django Cosmos DB (adaptador de PostgreSQL) Azure App Service repo
azure-django-postgres-addon-aca Django Complemento PostgreSQL de Azure Container Apps Azure Container Apps repo

¿Cómo funcionan las plantillas?

Se usan varios azd comandos para realizar tareas definidas por una azd plantilla. Estos comandos se tratan en detalle en Introducción al uso de la CLI para desarrolladores de Azure.

La azd plantilla consta de un repositorio de GitHub que contiene el código de aplicación (código de Python que usa un marco web popular) y los archivos de infraestructura como código (es decir, Bicep) para crear los recursos de Azure. También contiene la configuración necesaria para configurar un repositorio de GitHub con una canalización de CI/CD.

El inicio rápido le guía por los pasos para usar una plantilla específica azd . Solo requiere ejecutar cinco instrucciones de línea de comandos para el entorno de hospedaje de producción y el entorno de desarrollo local:

  1. azd init --template <template name> : crea un nuevo proyecto a partir de una plantilla y crea una copia del código de aplicación en el equipo local. El comando le pide que proporcione un nombre de entorno (como "myapp") que se usa como prefijo int en la nomenclatura de los recursos implementados.
  2. azd auth login : inicia sesión en Azure. El comando abre una ventana del explorador donde puede iniciar sesión en Azure. Después de iniciar sesión, se cierra la ventana del explorador y se completa el comando. El azd auth login comando solo es necesario la primera vez que use la CLI para desarrolladores de Azure (azd) por sesión.
  3. azd up : aprovisiona los recursos en la nube e implementa la aplicación en esos recursos.
  4. azd deploy : implementa los cambios en el código fuente de la aplicación en los recursos ya aprovisionados por azd up.
  5. azd down : elimina los recursos de Azure y la canalización de CI/CD si se usó.

Sugerencia

Vea la salida de azd las solicitudes que necesita responder. Por ejemplo, después de ejecutar el azd up comando, puede que se le pida que seleccione una suscripción si pertenece a más de una. Además, se le pedirá que seleccione una región. Puede cambiar las respuestas a las solicitudes editando las variables de entorno almacenadas en la carpeta /.azure/ de la plantilla.

Una vez finalizada la plantilla, tiene una copia personal de la plantilla original donde puede modificar cada archivo según sea necesario. Como mínimo, puede modificar el código del proyecto de Python para que el proyecto tenga la lógica de diseño y aplicación. También puede modificar la configuración de infraestructura como código si necesita cambiar los recursos de Azure. Consulte la sección titulada ¿Qué puedo editar o eliminar?

Opcional: Modificar y volver a aprovisionar recursos de Azure

Si desea cambiar los recursos de Azure que se aprovisionan, puede editar los archivos de Bicep adecuados en la plantilla y usarlos:

  1. azd provision : vuelve a aprovisionar los recursos de Azure en el estado deseado tal como se define en los archivos de Bicep.

Configuración de una canalización de CI/CD

La CLI para desarrolladores de Azure (azd) proporciona una manera sencilla de configurar una canalización de CI/CD para la nueva aplicación web de Python. Cada vez que combina confirmaciones o solicitudes de incorporación de cambios en la rama principal, la canalización de CI/CD compila y publica automáticamente los cambios en los recursos de Azure.

Opcional: configurar automáticamente la canalización de CI/CD de Acciones de GitHub

Si desea implementar la funcionalidad de canalización de CI/CD de Acciones de GitHub, use el siguiente comando:

  1. azd pipeline config : permite designar un repositorio y una configuración de GitHub para habilitar la canalización de CI\CD. Una vez configurado, cada vez que se combinan los cambios de código en la rama principal del repositorio, la canalización implementa los cambios en los servicios de Azure aprovisionados.

¿Cuáles son mis otras opciones?

Si no quiere usar azd plantillas, puede implementar la aplicación de Python en Azure y crear recursos de Azure de muchas maneras.

Puede realizar muchos de los pasos de creación e implementación de recursos mediante una de las siguientes herramientas:

O bien, si busca un tutorial completo que incluya marcos de desarrollo web de Python, consulte:

¿Tengo que usar contenedores de desarrollo?

No. Las plantillas web azd de Python usan contenedores de desarrollo de forma predeterminada. Los contenedores de desarrollo proporcionan muchas ventajas, pero requieren algunos conocimientos y software previos. Si no quiere usar contenedores de desarrollo y prefiere usar el entorno de desarrollo local en su lugar, consulte el archivo README.md en el directorio raíz de la aplicación de ejemplo para obtener instrucciones de configuración del entorno.

¿Qué puedo editar o eliminar?

El contenido de cada azd plantilla puede variar en función del tipo de proyecto y de la pila de tecnología subyacente empleada. Las plantillas enumeradas en este artículo siguen una convención común:

Carpeta o archivos Propósito Descripción
/ directorio raíz El directorio raíz contiene muchos tipos diferentes de archivos y carpetas para muchos propósitos diferentes.
/.Azul Archivos de configuración azd Contiene las variables de entorno que usan los comandos de la CLI para desarrolladores de Azure (azd). Esta carpeta se crea después de ejecutar el azd init comando . Puede cambiar los valores de las variables de entorno para personalizar la aplicación y los recursos de Azure. Para obtener más información, vea Archivo .env específico del entorno.
/.devcontainer Archivos de configuración del contenedor de desarrollo Los contenedores de desarrollo permiten crear un entorno de desarrollo basado en contenedores completo con todos los recursos que necesita para el desarrollo de software dentro de Visual Studio Code.
.github/ Configuración de Acciones de GitHub Contiene los valores de configuración de la canalización opcional de CI/CD de Acciones de GitHub, así como linting y pruebas. El archivo azure-dev.yaml se puede modificar o eliminar si no desea configurar la canalización de Acciones de GitHub mediante azd pipeline config el comando .
/Infra Archivos de Bicep Bicep permite declarar los recursos de Azure que desea implementar en el entorno. Solo debe modificar los archivos main.bicep y web.bicep . Consulte Inicio rápido: Escalado de servicios implementados con las azd plantillas web de Python mediante Bicep.
src/ archivos de código de proyecto de inicio Incluye las plantillas necesarias para el marco web, los archivos estáticos, los archivos .py para la lógica de código y los modelos de datos, un requirements.txt, etc. Los archivos específicos dependen del marco web, del marco de acceso a datos, etc. Puede modificar estos archivos para que se adapten a los requisitos del proyecto.
/.cruft.json archivo de generación de plantillas Se usa internamente para generar las azd plantillas. Puede eliminar este archivo de forma segura.
/.gitattributes Atributos de Git Proporciona a Git una configuración importante sobre el control de archivos y carpetas. Puede modificar este archivo según sea necesario.
/.gitignore git ignore Indica a Git que omita archivos y carpetas de que se incluyan en el repositorio. Puede modificar este archivo según sea necesario.
/azure.yaml azd archivo de configuración Contiene los valores de configuración para azd up declarar qué servicios y carpetas de proyecto se implementarán. Este archivo NO DEBE eliminarse.
/*.Md Archivos markdown Hay varios archivos markdown con distintos fines. Puede eliminar estos archivos de forma segura.
/docker-compose.yml Docker Compose Crea el paquete de contenedor para la aplicación antes de implementarlo en Azure.
/pyproject.toml Sistema de compilación de Python Contiene los requisitos del sistema de compilación de proyectos de Python. Puede modificar este archivo para incluir las herramientas preferidas (por ejemplo, para usar un marco de pruebas unitarias y linter).
/requirements-dev.in Archivo de requisitos de pip Se usa para crear una versión del entorno de desarrollo de los requisitos mediante pip install -r el comando . Puede modificar este archivo para incluir otros paquetes según sea necesario.

Sugerencia

Use buenas prácticas de control de versiones para poder volver a un momento dado cuando el proyecto estaba trabajando en caso de que interrumpa algo.

Preguntas más frecuentes

P: Tengo un error al usar una azd plantilla. ¿Qué puedo hacer?

R: Consulte Solución de problemas de la CLI para desarrolladores de Azure. También puede notificar problemas en el repositorio de GitHub de la plantilla correspondiente azd .