Skip to content

13. Apêndices

13.1. Instalando o Python

Os exemplos e o estudo de caso exigem o [Python] 3.12 ou posterior (o [Django] 6.1 o exige). Eles foram testados com a versão 3.13.

No [Windows], baixe o instalador na página python.org/downloads (o botão "Download Python 3.13.x", ou uma versão mais recente). Na primeira tela do instalador, marque a caixa "Add python.exe to PATH", o que permite digitar [python] em qualquer console, e depois clique em "Install Now". O instalador também instala o [pip], o módulo [venv] e o launcher [py] ([py -3.13] inicia uma versão específica quando há várias versões instaladas). No [Windows] 10 e 11, digitar [python] sem tê-lo instalado abre a Microsoft Store: trata-se de um atalho do sistema que pode ser desativado (Configurações / Aplicativos / Configurações avançadas de aplicativos / Aliases de execução de aplicativo).

No [macOS], use o instalador do python.org ou o gerenciador de pacotes [Homebrew]: [brew install python@3.13]. No [Linux], o [Python] já está presente, mas os módulos [venv] e [pip] costumam ser pacotes separados. No [Ubuntu] 24.04 (em que a versão do [Python] é a 3.12):

sudo apt install python3 python3-venv python3-pip

No [macOS] e no [Linux], os comandos se chamam [python3] e [pip3]; em um ambiente virtual ativado, [python] e [pip] bastam. Verifique a instalação em um novo console:

python --version
python -m pip --version

O primeiro comando deve exibir um número de versão igual ou superior a 3.12 (por exemplo, [Python 3.13.7]).

13.2. pip e ambientes virtuais

O [pip] é o gerenciador de bibliotecas do [Python]. Ele baixa as bibliotecas do repositório [PyPI] (pypi.org): é necessária uma conexão com a Internet durante a instalação. Se você estiver atrás de um proxy corporativo, especifique o proxy por meio das variáveis de ambiente [HTTP_PROXY] e [HTTPS_PROXY], ou por meio da opção [--proxy] do [pip].

Um ambiente virtual é uma pasta que contém uma cópia leve do interpretador [Python] e suas próprias bibliotecas: cada projeto tem as suas, nas versões de que precisa, sem afetar a instalação do [Python] nem os outros projetos. Comandos úteis em uma pasta de projeto (a que contém o [requirements.txt]):

1
2
3
4
5
6
7
python -m venv .venv                 # cria o ambiente virtual (pasta .venv)
.venv\Scripts\activate               # ativa-o (Windows)
source .venv/bin/activate            # ativa-o (Linux, macOS)
pip install -r requirements.txt      # instala as bibliotecas do projeto
pip list                             # as bibliotecas instaladas
pip freeze                           # a mesma lista, no formato requirements.txt
deactivate                           # sai do ambiente

No [Windows], o [PowerShell] às vezes se recusa a executar o script de ativação (“a execução de scripts está desabilitada neste sistema”): o comando [Set-ExecutionPolicy -Scope CurrentUser RemoteSigned] a habilita para o usuário atual. Também é possível dispensar a ativação chamando diretamente o interpretador do ambiente: [.venv\Scripts\python manage.py runserver].

A pasta [.venv] não pode ser copiada de uma máquina para outra (ela contém caminhos absolutos e programas específicos do sistema): ela deve ser recriada com os comandos acima. Por isso ela não está incluída no material do curso. A pasta [examples] tem seu próprio ambiente, compartilhado pelos 28 exemplos; o estudo de caso tem o seu.

A biblioteca [mysqlclient] e o driver [MySQL] (exemplo 28 e estudo de caso) são escritos em C. No [Windows], o [pip] baixa uma versão pré-compilada: nenhuma ação é necessária. No [Linux] e no [macOS], o [pip] a compila e, para isso, precisa dos arquivos de desenvolvimento do [MySQL] e de um compilador:

1
2
3
sudo apt install python3-dev default-libmysqlclient-dev build-essential pkg-config     # Ubuntu, Debian
brew install mysql-client pkg-config                                                    # macOS
export PKG_CONFIG_PATH="$(brew --prefix)/opt/mysql-client/lib/pkgconfig"                # macOS, antes de pip install

Sem eles, o [pip install -r requirements.txt] falha no [mysqlclient], com uma mensagem de erro que menciona [pkg-config] ou [mysql_config].

13.3. Instalando o Visual Studio Code

O [Visual Studio Code] é baixado em code.visualstudio.com. Adicione três extensões (menu View / Extensions):

  • Python (da Microsoft): para executar e depurar código [Python] e gerenciar ambientes virtuais. Ela instala junto a extensão Python Debugger;
  • Pylance (da Microsoft, também instalada com a extensão Python): autocompletar código, navegação no código (inclusive no código do [Django], localizado na pasta [.venv]), relatório de erros e verificação de anotações de tipo;
  • Django (de Baptiste Darthenay): realce de sintaxe e atalhos para os templates do [Django] (arquivos [.html] na pasta [templates]).

Abra a pasta [examples] ou a pasta do estudo de caso (menu File / Open Folder) e selecione o interpretador do ambiente virtual da pasta (Command Palette, Ctrl+Shift+P, Python: Select Interpreter e, em seguida, o do [.venv]). O terminal integrado (menu Terminal / New Terminal) passa então a ativar o ambiente automaticamente e permite executar aplicações e comandos [python manage.py ...] sem sair do editor.

Para executar uma aplicação passo a passo, crie uma configuração de depuração (menu Run / Add Configuration, depois Python Debugger e Django): o editor inicia o [manage.py runserver] sob o controle do depurador e pausa nos pontos de interrupção definidos nas views.

13.4. Instalando o MySQL com o Laragon

O [Laragon] instala um servidor [MySQL] pronto para uso no [Windows], junto com a ferramenta de administração [HeidiSQL] (veja “Instalando o Laragon” na introdução). Após a instalação:

  • o botão “Start All” inicia o servidor [MySQL] na porta 3306;
  • o usuário [root] não tem senha: esses são os valores da configuração [DATABASES] do exemplo 28 ([config/settings.py]) e das variáveis [DB_USER] e [DB_PASSWORD] do arquivo [.env] no estudo de caso;
  • o botão Database abre o [HeidiSQL], em que o item de menu File / Run a File (SQL) executa os scripts [dbpersons.sql] (exemplo 28) e [dbrdvmedecins2.sql] (estudo de caso).

No [Linux] ou no [macOS], instale o [MySQL] ou o [MariaDB] usando o gerenciador de pacotes do sistema e execute os scripts com o cliente de linha de comando [mysql] ([mysql -u root < database/dbrdvmedecins2.sql]). O driver [mysqlclient] e a engine [MySQL] do [Django] funcionam com ambos sem nenhuma configuração. No [Linux], a conta [root] do [MariaDB] costuma ser configurada para entrar somente pela conta de sistema [root] ([sudo mysql]): cria-se então um usuário para as aplicações:

sudo mysql -e "CREATE USER 'course'@'localhost' IDENTIFIED BY 'course'; GRANT ALL ON dbpersons.* TO 'course'@'localhost'; GRANT ALL ON dbrdvmedecins2.* TO 'course'@'localhost';"

e informamos isso às aplicações: as chaves [USER] e [PASSWORD] da configuração [DATABASES] no exemplo 28, as linhas [DB_USER=course] and [DB_PASSWORD=course] do arquivo [.env] no estudo de caso.

13.5. Instalando o curl

O [curl] vem incluído no [Windows] 10 e 11, no [macOS], e na maioria das distribuições [Linux]. No [PowerShell], é preciso digitar [curl.exe], e não [curl]: nas versões mais antigas do [PowerShell], o [curl] é um alias de outro comando ([Invoke-WebRequest]), que tem opções diferentes. No prompt de comando do [Windows] ([cmd]), as aspas de uma string JSON são escritas como [\"] (exemplo 11), e uma URL que contenha [&] deve ser colocada entre aspas duplas.

13.6. O utilitário django-admin

O [Django] instala um comando, o [django-admin], que não é necessário para acompanhar este documento (os exemplos são fornecidos prontos para uso), mas serve para iniciar um novo projeto. O arquivo [manage.py] de cada projeto é um arquivo [django-admin] que também conhece as configurações do projeto: dentro de um projeto, digita-se [python manage.py] em vez de [django-admin]. Os comandos mais úteis:

django-admin startproject config .        # um novo projeto, cuja configuração é o pacote config
python manage.py startapp pages           # uma nova aplicação, a pasta pages
python manage.py runserver 8000           # o servidor de desenvolvimento
python manage.py check                    # verifica o projeto (configurações, rotas, modelos...)
python manage.py check --deploy           # verifica as configurações de segurança para produção
python manage.py shell                    # um console Python, com o Django carregado
python manage.py dbshell                  # o cliente do banco de dados, com as configurações do projeto
python manage.py inspectdb                # escreve os modelos de um banco de dados existente (a revisar e corrigir)
python manage.py makemessages -l fr       # coleta os textos a traduzir (arquivo .po)
python manage.py compilemessages          # compila os dicionários (arquivos .mo)
python manage.py collectstatic            # reúne os arquivos estáticos para produção
python manage.py diffsettings             # as configurações que diferem dos valores padrão

O ponto no final do comando [startproject] cria o projeto na pasta atual (sem ele, o projeto é criado em uma nova pasta chamada [config]). Uma aplicação criada pelo [startapp] deve ser adicionada à lista de configurações [INSTALLED_APPS] . O comando [inspectdb] é uma ferramenta valiosa para um banco de dados existente, como o do estudo de caso: ele lê as tabelas e gera um primeiro rascunho dos modelos usando [managed = False]; resta apenas nomear os relacionamentos, escolher os tipos e adicionar os métodos. Os comandos [makemigrations] e [migrate], que criam e atualizam tabelas com base nos modelos, não foram usados neste documento: seus bancos de dados são criados por scripts SQL, compartilhados com outras versões da aplicação.