Compartilhar via

Visão geral dos modelos do Python Web azd

  • Artigo

Os modelos Python Web Azure Developer CLI (azd) são a maneira mais rápida e fácil de começar a criar e implantar aplicativos Web Python no Azure. Este artigo fornece informações básicas contextuais à medida que você está começando.

A melhor maneira de começar é seguir o guia de início rápido para criar seu primeiro aplicativo Web Python e implantá-lo no Azure em minutos com azd modelos. Se você não quiser configurar um ambiente de desenvolvimento local, ainda poderá seguir o início rápido usando o GitHub Codespaces .

O que são os modelos web azd do Python?

Há muitos azd modelos disponíveis na galeria Awesome AZD Templates. No entanto, essa coleção de modelos da Web Python é única, pois eles fornecem um aplicativo Web de exemplo com paridade de recursos em muitas combinações populares diferentes de recursos do Azure e estruturas da Web azd do Python.

Ao executar um modelo da Web azd Python, você irá:

  • Crie um aplicativo inicial - Especificamente, um site para uma empresa fictícia chamada Relecloud. O código do projeto apresenta muitas práticas recomendadas para as estruturas e pacotes Python fornecidos que são necessários para essa pilha específica de tecnologias. O modelo destina-se a ser um ponto de partida para a sua aplicação. Você adiciona ou remove a lógica do aplicativo e os recursos do Azure conforme necessário.
  • Provisionar recursos do Azure - O modelo provisiona recursos do Azure para hospedar seu aplicativo Web e banco de dados usando o Bicep, uma ferramenta popular de infraestrutura como código. Novamente, você modifica os modelos do Bicep se precisar adicionar mais serviços do Azure.
  • Implantar o aplicativo inicial nos recursos do Azure recém-provisionados - O aplicativo inicial é implantado automaticamente para que você possa ver tudo funcionando em minutos e decidir o que deseja modificar.
  • Opcional: Configurar um repositório do GitHub e um pipeline de CI/CD - Se desejar, o modelo contém a lógica para configurar um repositório do GitHub para você, incluindo um pipeline de CI/CD do GitHub Actions. Em poucos minutos, você pode fazer alterações no código do projeto da Web. Quando você mescla essas alterações na ramificação principal do repositório GitHub, o pipeline de CI/CD as publica em seu novo ambiente de hospedagem do Azure.

A quem se destina?

Os modelos destinam-se a ser usados por desenvolvedores Web Python experientes que desejam começar a criar um novo aplicativo Web Python visando a implantação do Azure.

Por que eu gostaria de usar isso?

O uso dos azd modelos oferece vários benefícios:

  • Início mais rápido possível - Com o ambiente de desenvolvimento local e as configurações do ambiente de hospedagem fora do caminho, você pode se concentrar na criação de seu aplicativo em minutos.
  • Início mais fácil possível - Execute apenas algumas instruções de linha de comando para criar todo um ambiente local de desenvolvimento, hospedagem e implantação. O fluxo de trabalho é fácil de usar e fácil de lembrar.
  • Desenvolver com base nas práticas recomendadas - Cada modelo é criado e mantido pelo Python em veteranos do setor do Azure. Adicione seu código seguindo suas abordagens de design para construir sobre uma base sólida.

Índice de modelos

A tabela a seguir lista os monikers de modelo da Web azd Python disponíveis para usar com o comando, as tecnologias implementadas em cada modelo e um link para o azd init repositório do GitHub se você quiser contribuir com alterações.

Modelo Estrutura Web Backup de banco de dados Plataforma de Hospedagem Repositório GitHub
azure-django-postgres-flexible-aca Django Servidor flexível PostgreSQL Aplicativos de Contêiner do Azure repositório
azure-django-postgres-flexible-appservice Django Servidor flexível PostgreSQL Serviço de Aplicativo do Azure repositório
azure-django-cosmos-postgres-aca Django Cosmos DB (Adaptador PostgreSQL) Aplicativos de Contêiner do Azure repositório
azure-django-cosmos-postgres-appservice Django Cosmos DB (Adaptador PostgreSQL) Serviço de Aplicativo do Azure repositório
azure-django-postgres-addon-aca Django Complemento PostgreSQL de Aplicativos de Contêiner do Azure Aplicativos de Contêiner do Azure repositório

Como funcionam os modelos?

Você usa vários azd comandos para executar tarefas definidas por um azd modelo. Esses comandos são abordados em detalhes em Introdução ao uso da CLI do desenvolvedor do Azure.

O azd modelo compreende um repositório GitHub contendo o código do aplicativo (código Python utilizando uma estrutura da Web popular) e os arquivos de infraestrutura como código (ou seja, Bicep) para criar os recursos do Azure. Ele também contém a configuração necessária para configurar um repositório GitHub com um pipeline de CI/CD.

O guia de início rápido orienta você pelas etapas para usar um modelo específico azd . Ele requer apenas que você execute cinco instruções de linha de comando para o ambiente de hospedagem de produção e o ambiente de desenvolvimento local:

  1. azd init --template <template name> - cria um novo projeto a partir de um modelo e cria uma cópia do código do aplicativo em seu computador local. O comando solicita que você forneça um nome de ambiente (como "myapp") que é usado como um prefixo na nomeação dos recursos implantados.
  2. azd auth login - efetua login no Azure. O comando abre uma janela do navegador onde você pode entrar no Azure. Depois de entrar, a janela do navegador é fechada e o comando é concluído. O azd auth login comando só é necessário na primeira vez que você usa a CLI do Desenvolvedor do Azure (azd) por sessão.
  3. azd up - provisiona os recursos de nuvem e implanta o aplicativo nesses recursos.
  4. azd deploy - implanta alterações no código-fonte do aplicativo para recursos já provisionados pelo azd up.
  5. azd down - exclui os recursos do Azure e o pipeline de CI/CD se ele foi usado.

Dica

Observe a saída para azd os prompts que você precisa responder. Por exemplo, depois de executar o azd up comando, você pode ser solicitado a selecionar uma assinatura se pertencer a mais de uma. Além disso, você será solicitado a selecionar uma região. Você pode alterar as respostas aos prompts editando as variáveis de ambiente armazenadas na pasta /.azure/ do modelo.

Depois que o modelo terminar, você terá uma cópia pessoal do modelo original, onde poderá modificar todos os arquivos conforme necessário. No mínimo, você pode modificar o código do projeto Python para que o projeto tenha seu design e lógica de aplicativo. Você também pode modificar a configuração de infraestrutura como código se precisar alterar os recursos do Azure. Consulte a seção intitulada O que posso editar ou excluir?

Opcional: modificar e reprovisionar recursos do Azure

Se você quiser alterar os recursos do Azure provisionados, poderá editar os arquivos Bicep apropriados no modelo e usar:

  1. azd provision - reprovisiona os recursos do Azure para o estado desejado, conforme definido nos arquivos Bicep.

Configurar um pipeline de CI/CD

A CLI do Desenvolvedor do Azure (azd) fornece uma maneira fácil de configurar um pipeline de CI/CD para seu novo aplicativo Web Python. Cada vez que você mescla confirmações ou solicitações pull em sua ramificação principal, o pipeline de CI/CD cria e publica automaticamente suas alterações em seus recursos do Azure.

Opcional: configurar automaticamente o pipeline de CI/CD de ações do GitHub

Se você deseja implementar a funcionalidade de pipeline de CI/CD do GitHub Actions, use o seguinte comando:

  1. azd pipeline config - Permite designar um repositório GitHub e configurações para habilitar o pipeline CI\CD. Depois de configurado, sempre que as alterações de código são mescladas na ramificação principal do repositório, o pipeline implanta as alterações em seus serviços provisionados do Azure.

Quais são as minhas outras opções?

Se você não quiser usar azd modelos, poderá implantar seu aplicativo Python no Azure e criar recursos do Azure de várias maneiras.

Você pode realizar muitas das etapas de criação e implantação de recursos usando uma das seguintes ferramentas:

Ou se você estiver procurando um tutorial completo que apresenta frameworks de desenvolvimento web Python, confira:

Preciso usar Dev Containers?

Não. Os modelos da Web azd Python utilizam Contêineres de Desenvolvimento por padrão. Os contêineres de desenvolvimento oferecem muitos benefícios, mas exigem alguns pré-requisitos de conhecimento e software. Se você não quiser usar Contêineres de Desenvolvimento e preferir usar seu ambiente de desenvolvimento local, consulte o arquivo README.md no diretório raiz do aplicativo de exemplo para obter instruções de configuração do ambiente.

O que posso editar ou excluir?

O conteúdo de cada azd modelo pode variar dependendo do tipo de projeto e da pilha de tecnologia subjacente empregada. Os modelos listados neste artigo seguem uma convenção comum:

Pasta/Arquivos Finalidade Descrição
/ diretório raiz O diretório raiz contém muitos tipos diferentes de arquivos e pastas para muitas finalidades diferentes.
/.azul arquivo de configuração azd Contém as variáveis de ambiente que são usadas pelos comandos () da CLIazd do Desenvolvedor do Azure. Esta pasta é criada depois de executar o azd init comando. Você pode alterar os valores das variáveis de ambiente para personalizar o aplicativo e os recursos do Azure. Para obter mais informações, consulte Arquivo .env específico do ambiente.
/.devcontainer Arquivos de configuração do Contêiner de Desenvolvimento Os contêineres de desenvolvimento permitem que você crie um ambiente de desenvolvimento baseado em contêiner completo com todos os recursos necessários para o desenvolvimento de software dentro do Visual Studio Code.
.github/ Configuração de ações do GitHub Contém as definições de configuração para o pipeline opcional de CI/CD do GitHub Actions, bem como linting e testes. O arquivo azure-dev.yaml pode ser modificado ou excluído se você não quiser configurar o pipeline de Ações do GitHub usando azd pipeline config o comando.
/infra Arquivos Bicep O Bicep permite que você declare os recursos do Azure que deseja implantar em seu ambiente. Você só deve modificar os arquivos main.bicep e web.bicep. Consulte Guia de início rápido: dimensionando serviços implantados com os modelos da Web Python usando o azd Bicep.
src/ Arquivos de código do projeto inicial Inclui todos os modelos exigidos pela estrutura da Web, arquivos estáticos, arquivos .py para a lógica de código e modelos de dados, um requirements.txte assim por diante. Os arquivos específicos dependem da estrutura da Web, da estrutura de acesso a dados e assim por diante. Você pode modificar esses arquivos para atender aos requisitos do projeto.
/.cruft.json arquivo de geração de modelo Usado internamente para gerar os azd modelos. Você pode excluir esse arquivo com segurança.
/.gitattributes Atributos do git Fornece ao git uma configuração importante sobre como manipular arquivos e pastas. Você pode modificar esse arquivo conforme necessário.
/.gitignore git ignorar Diz ao git para ignorar arquivos e pastas de serem incluídos no repositório. Você pode modificar esse arquivo conforme necessário.
/azure.yaml azd arquivo de configuração Contém as definições de configuração para azd up declarar quais serviços e pastas de projeto serão implantados. Este arquivo NÃO DEVE ser excluído.
/*.Md arquivos de markdown Existem vários arquivos de marcação para diferentes finalidades. Você pode excluir esses arquivos com segurança.
/docker-compose.yml Docker Compose Cria o pacote de contêiner para o aplicativo antes de ser implantado no Azure.
/pyproject.toml Sistema de compilação Python Contém os requisitos do sistema de compilação de projetos Python. Você pode modificar esse arquivo para incluir suas ferramentas preferidas (por exemplo, para usar um linter e uma estrutura de teste de unidade).
/requirements-dev.in Arquivo de requisitos pip Usado para criar uma versão de ambiente de desenvolvimento dos requisitos usando pip install -r o comando. Você pode modificar esse arquivo para incluir outros pacotes conforme necessário.

Dica

Use boas práticas de controle de versão para que você possa voltar a um ponto no tempo em que o projeto estava funcionando, caso você inexplicavelmente quebre algo.

Perguntas frequentes

P: Recebi um erro ao usar um azd modelo. O que posso fazer?

R: Consulte Solucionar problemas da CLI do desenvolvedor do Azure. Você também pode relatar problemas no repositório GitHub do respectivo azd modelo.