Visão geral dos templates web Python do azd
Os modelos Python Web Azure Developer CLI (azd) são a maneira mais rápida e fácil de criar e implantar aplicativos Web Python no Azure. Este artigo fornece informações contextuais à medida que você começa a trabalhar com os modelos.
A melhor abordagem para começar é seguir o guia de início rápido para criar a sua primeira aplicação web Python e implantá-la no Azure em poucos minutos usando azd modelos. Se preferir não configurar um ambiente de desenvolvimento local, você ainda pode seguir o início rápido usando o GitHub Codespaces em vez disso.
O que são os modelos azd da web do Python?
Os modelos de azd destinam-se a desenvolvedores Web Python experientes que desejam criar aplicativos Web Python destinados à implantação do Azure. Os modelos fornecem o de início
Depois de configurar seus ambientes de desenvolvimento e hospedagem, os modelos fornecem o início mais rápido possível para criar seu aplicativo Web Python. Ao configurar os arquivos de código de modelo para atender aos seus requisitos específicos, você pode personalizar seu aplicativo Web Python em minutos.
Os modelos também ajudam você a seguir estratégias de design estabelecidas e desenvolver as melhores práticas. Siga os designs de modelo e adicione seu código construindo sobre bases sólidas. Os modelos são criados e mantidos por veteranos do setor com ampla experiência em desenvolvimento em Python no Azure.
Que tarefas posso fazer com os modelos?
Ao executar um modelo de azd da Web Python, você conclui rapidamente várias tarefas:
- Criar aplicativo inicial. Você cria um site para uma empresa fictícia chamada Relecloud. O código do projeto apresenta muitas práticas recomendadas para as estruturas Python e pacotes 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. Você provisiona recursos do Azure para hospedar a sua aplicação web e a base de dados usando o Bicep, uma ferramenta popular de infraestrutura-como-código. Semelhante à tarefa anterior, você pode modificar os modelos do Bicep para adicionar mais serviços do Azure, conforme necessário.
- Implantar o aplicativo inicial nos recursos provisionados do Azure. Você implanta automaticamente seu aplicativo inicial. Essa abordagem permite que você revise rapidamente o programa em execução e decida o que deseja modificar.
-
(Opcional) Configurar o repositório GitHub e o pipeline de CI/CD. Como opção, você pode configurar um repositório GitHub, incluindo um pipeline de integração contínua/entrega contínua (CI/CD) do GitHub Actions . Essa abordagem permite que você faça alterações rapidamente no código do projeto da Web. Quando você mescla essas alterações na ramificação principal do
do seu repositório GitHub, o pipeline de CI/CD as publica em seu novo ambiente de hospedagem do Azure.
Onde posso aceder aos modelos?
Muitos modelos azd estão disponíveis na galeria Awesome Azure Developer CLI Templates. Esta coleção oferece modelos de azd Web Python exclusivos que fornecem um aplicativo Web de exemplo com paridade de recursos em muitas combinações populares diferentes de recursos do Azure e estruturas da Web Python.
As tabelas a seguir listam os monikers de modelo de azd da Web Python que estão disponíveis para uso com o comando azd init. As tabelas identificam as tecnologias implementadas em cada modelo e fornecem um link para o repositório GitHub correspondente, onde você pode contribuir com alterações.
Índice de modelos
A tabela a seguir lista os nomes de modelo da Web Python azd disponíveis a usar com o comando azd init, as tecnologias implementadas em cada modelo e um link para o repositório GitHub caso queira contribuir para alterações.
Os seguintes modelos de azd estão disponíveis para o Django web framework.
Como devo usar os modelos?
Cada modelo de azd compreende um repositório do GitHub que contém o código da aplicação (código Python que utiliza um framework web popular) e os arquivos de infraestrutura como código (nomeadamente, Bicep) para criar os recursos do Azure. O modelo também contém a configuração necessária para configurar um repositório GitHub com um pipeline de CI/CD.
Para executar as tarefas definidas por um modelo da Web azd, use vários comandos Python azd. Para obter descrições detalhadas desses comandos, consulte Guia de início rápido : implantar um modelo de CLI do desenvolvedor do Azure. As instruções rápidas orientam-no pelas etapas para utilizar um modelo específico azd. Você só precisa executar cinco instruções de linha de comando essenciais para o ambiente de hospedagem de produção e o ambiente de desenvolvimento local.
A tabela a seguir resume os cinco comandos essenciais:
| Comando | Descrição da tarefa |
|---|---|
azd init --template <template name> |
Crie um novo projeto a partir de um modelo e crie 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. |
azd auth login |
Entre no Azure. O comando abre uma janela do navegador onde você pode entrar no Azure. Depois de iniciar sessão, a janela do browser fecha e o comando é concluído. O comando azd auth login é necessário somente na primeira vez que você usa a CLI do Desenvolvedor do Azure (azd) por sessão. |
azd up |
Provisione os recursos de nuvem e implante o aplicativo nesses recursos. |
azd deploy |
Implante alterações no código-fonte do aplicativo em recursos já provisionados pelo comando azd up. |
azd down |
Se tiver sido utilizado, elimine os recursos do Azure e o pipeline de CI/CD. |
Dica
Quando você trabalha com os comandos azd, observe as solicitações para inserir mais informações. Depois de executar o comando azd up, você pode ser solicitado a selecionar uma assinatura, se tiver mais de uma. Você também pode ser solicitado a especificar sua região. Você pode alterar as respostas aos prompts editando as variáveis de ambiente armazenadas na pasta /.azure/ do modelo.
Depois de concluir as tarefas essenciais do modelo, você terá uma cópia pessoal do modelo original onde poderá modificar qualquer arquivo, conforme necessário. No mínimo, você pode modificar o código do projeto Python para que o projeto use 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. Para obter mais informações, consulte a seção O que posso editar ou excluir mais adiante neste artigo.
Tarefas de modelo opcionais
Além dos cinco comandos essenciais, há tarefas opcionais que você pode concluir com os modelos azd.
Reprovisionar e modificar recursos do Azure
Depois de provisionar recursos do Azure com um modelo de azd, você pode modificar e reprovisionar um recurso.
- Para modificar um recurso provisionado, você editar os arquivos Bicep apropriados no modelo.
- Para iniciar a tarefa de reprovisionamento, use o comando
azd provision.
Configurar uma 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. Quando você mescla confirmações ou solicitações de pull em sua ramificação principal, o pipeline cria e publica automaticamente as alterações em seus recursos do Azure.
- Para configurar a pipeline de CI/CD, indique o repositório GitHub e as configurações pretendidas para ativar a pipeline.
- Para criar o pipeline, use o comando
azd pipeline config.
Alternativas aos modelos
Se você preferir não usar os modelos de azd Web do Python, há métodos alternativos para implantar aplicativos Web Python no Azure e provisionar recursos do Azure.
Você pode criar muitos recursos e concluir as etapas de implantação usando várias ferramentas:
Você também pode seguir um tutorial de ponta a ponta que apresenta estruturas de desenvolvimento web Python:
- Implantar um aplicativo Web Flask ou FastAPI no Serviço de Aplicativo do Azure
- aplicativo Web Python em contêineres no Azure com MongoDB
Perguntas frequentes
As seções a seguir resumem as respostas às perguntas freqüentes sobre como trabalhar com os modelos de azd da Web do Python.
Tenho que usar Dev Containers?
Não. Os modelos de azd da Web Python usam de contêineres de desenvolvimento de código do Visual Studio por padrão. Os Contêineres de Desenvolvimento oferecem muitos benefícios, mas exigem alguns pré-requisitos de conhecimento e software. Se você preferir não usar contêineres de desenvolvimento e, em vez disso, usar seu ambiente de desenvolvimento local, consulte o arquivo de README.md no diretório raiz do aplicativo de exemplo para obter instruções de configuração do ambiente.
O que posso editar ou eliminar?
Os conteúdos de cada modelo de azd podem variar em função do tipo de projeto e da pilha tecnológica subjacente utilizada. Os modelos listados neste artigo seguem uma convenção comum:
O conteúdo de cada modelo de azd web Python pode variar dependendo do tipo de projeto e da pilha de tecnologia subjacente empregada. Os modelos identificados neste artigo seguem uma convenção comum de pasta e arquivo, conforme descrito na tabela a seguir.
| Pasta/ficheiro(s) | Finalidade | Descrição |
|---|---|---|
| / | Diretório raiz | A pasta raiz para cada modelo contém muitos tipos diferentes de arquivos e pastas para finalidades diferentes. |
| /.azure |
azd arquivos de configuração |
A pasta .azure é criada depois de executar o comando azd init. A pasta armazena arquivos de configuração para as variáveis de ambiente usadas pelos comandos azd. 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 Dev Container | 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. A pasta .devcontainer é criada depois que o Visual Studio Code gera um arquivo de configuração de Dev Container em resposta a um comando de modelo. |
| /.github | Arquivos de configuração do GitHub Actions | Esta pasta contém definições de configuração para o pipeline, linting e testes opcionais do GitHub Actions CI/CD. Se você não quiser configurar o pipeline de Ações do GitHub usando |
| /infra | Arquivos Bicep | A pasta infra contém os ficheiros de configuração do Bicep. O Bicep permite que você declare os recursos do Azure que deseja implantar em seu ambiente. Você só deve modificar o main.bicep e web.bicep arquivos. Para obter mais informações, consulte Guia de início rápido: escalando serviços implantados com os modelos Web Python do azd usando o Bicep. |
| /src | Arquivos de código do projeto inicial | A pasta src contém vários arquivos de código necessários para preparar o projeto inicial. Exemplos dos arquivos incluem modelos exigidos pela estrutura da web, arquivos estáticos, arquivos Python (.py) para a lógica de código e modelos de dados, um arquivo requirements.txt e muito mais. 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 seu projeto. |
| /.cruft.json | Arquivo de geração de modelo | O arquivo .cruft JSON é usado internamente para gerar os modelos de azd da Web do Python. Você pode excluir esse arquivo com segurança, conforme necessário. |
| /.gitattributes | Arquivo com configurações de atributo para git | Este arquivo fornece ao git definições de configuração importantes para lidar com arquivos e pastas. Você pode modificar esse arquivo, conforme necessário. |
| /.gitignore | Arquivo com itens ignorados para git | O arquivo .gitignore informa o git sobre os arquivos e pastas a serem excluídos (ignorados) ao gravar no repositório GitHub para o modelo. Você pode modificar esse arquivo, conforme necessário. |
| /azure.yaml |
azd up arquivo de configuração |
Este arquivo de configuração contém as definições de configuração para o comando azd up. Ele especifica os serviços e as pastas de projeto a serem implantadas.
Importante: Este arquivo não deve ser excluído. |
| /*.md | Arquivos de formato Markdown | Um modelo pode incluir vários arquivos de formato Markdown (.md) para diferentes finalidades. Você pode excluir arquivos Markdown com segurança. |
| /docker-compose.yml | Configurações de composição do Docker | Esse arquivo YML cria o pacote de contêiner para o aplicativo Web Python antes que o aplicativo seja implantado no Azure. |
| /pyproject.toml | Ficheiro de configurações de compilação do Python | O arquivo TOML contém os requisitos de sistema de compilação de projetos Python. Pode modificar este ficheiro para definir as suas preferências de ferramentas, como um linter específico ou uma estrutura de teste de unidade. |
| /requirements-dev.in | ficheiro de requisitos do pip | Esse arquivo é usado para criar uma versão do ambiente de desenvolvimento dos requisitos usando o comando pip install -r. Você pode modificar esse arquivo para incluir outros pacotes, conforme necessário. |
Dica
Ao modificar arquivos de modelo para seu programa, certifique-se de praticar um bom controle de versão. Essa abordagem pode ajudá-lo a restaurar o repositório para uma versão de trabalho anterior, se novas alterações causarem problemas no programa.
Como posso lidar com erros de modelo?
Se receber um erro ao usar um template de azd, reveja as opções descritas no artigo Resolução de Problemas da CLI de Desenvolvedor do Azure. Você também pode relatar problemas no repositório GitHub associado ao modelo azd.