Configurar o PyCharm Para o Projecto - HelpingHandPT/COVID19-be GitHub Wiki

Qualquer editor ou IDE de python pode ser usado para este projecto. Esta página detalha como configurar e usar o PyCharm para o projecto.

O PyCharm é um dos IDE's mais populares para python e é compatível com todos os 3 sistemas operativos mais comuns: Windows, Mac OS e Sistemas Baseados em Linux.

O IDE dispõe de três edições:

  • A versão Comunidade que é gratuita
  • A versão Educação que é gratuita para estudantes com um UI mais simples do que a versão Comunidade
  • A versão Profissional que e paga e inclui mais suporte para aplicações específicas

Enquanto que a versão Profissional já tem integrado o suporte para Django, a versão de Comunidade não inclui esse suporte. Este guia aplica-se à versão de Comunidade.

Nota

O PyCharm cria automaticamente pastas .idea que armazenam as configurações do IDE. Estas pastas são ignoradas pelo git durante os commits pelo que não é necessário utilizar o projecto fora do repositório.

Abrir o Projecto e Configurar o Interpretador e Ambiente Virtual

  1. Abrir o PyCharm e selecionar Open:
  1. Navegar até ao repositório e escolher a raíz do servidor que está dentro do repositório (COVID19-be\django_server)
  1. O projecto estará agora aberto no PyCharm. O PyCharm deverá ainda detectar o repositório GitHub e permite facilmente efectuar Commit/Push a partir dos menus.
  1. Ir agora a File > Settings > Project: django_server > Project Interpreter
  1. Clicar na caixa de opções e escolher Show All...
  1. Uma nova caixa de diálogo devera abrir para escolher um interpretador. Clicar no botão +
  1. Escolher Virtualenv Environment. Nas duas opções, seleccionar Existing Environment e clicar no botão ...
  1. Na nova caixa de diálogo, é necessário encontrar o caminho do binário do interpretador do Python na directoria do ambiente virtual. O caminho depende de onde foi criado o ambiente virtual e do sistema operativo.

Por exemplo, para um ambiente virtual designado myenv, a localização do executável será:

  • Windows: myenv/Scripts/python.exe
  • Mac OS X/Linux: myenv/bin/python.exe
  1. Após isto, clicar em OK e novamente em OK. O PyCharm irá agora indexar todos os ficheiros .py para providenciar algumas sugestões e mostrar a documentação das bibliotecas.

Configurar Execução do Projecto

  1. Para correr o servidor directamente no IDE, clicar na barra de topo, à direita em Add Configuration...
  1. Clicar no botão + e escolher Python
  1. Em Script path:, inserir a localização do ficheiro manage.py, localizado dentro da pasta do servidor (COVID19-be/django_server/manage.py)

  2. Em Parameters: inserir runserver

  3. Opcionalmente, poderá ser dado um nome mais específico à configuração em Name, por exemplo, algo como "Run Server"

  4. Certificar que Python interpreter corresponde ao ambiente virtual criado para este projecto.

  5. No fim, a configuração deverá estar assim. Clicar em OK

  1. Finalmente, para correr o projecto, clicar no botão