Instalação

Se você estiver instalando a biblioteca do PyPI ou clonando-a do GitHub, recomendamos realizar as etapas abaixo usando um ambiente virtual ativo. Para mais informações sobre como criar e ativar um ambiente virtual, consulte a documentação Ambiente virtual.

Instalar o módulo do PyPI

A biblioteca é distribuída em PyPI e pode ser instalada usando pip com o seguinte comando:

python -m pip install google-ads

Instalar a biblioteca do GitHub

O código-fonte da biblioteca pode ser clonado do GitHub para sua máquina local. Vale a pena clonar o código-fonte para executar os exemplos com facilidade ou desenvolver a própria biblioteca. Como referência, a execução de um dos exemplos de autenticação é uma etapa necessária na configuração da biblioteca para uso.

  1. Verifique se python3.8 ou uma versão mais recente está presente no ambiente. A maneira mais simples é usar pyenv:

    pyenv local 3.8
    
  2. Clone a biblioteca de cliente do GitHub:

    git clone git@github.com:googleads/google-ads-python.git
    
  3. Insira o repositório e instale-o:

    cd google-ads-python
    python -m pip install .
    
  4. Se você pretende desenvolver a biblioteca, execute os testes de unidade antes e depois de fazer qualquer mudança:

    1. Verifique se todas as versões compatíveis da linguagem Python estão disponíveis no seu ambiente. Usando pyenv:

      pyenv local 3.8 3.9 3.10 3.11 3.12
      
    2. Instale as dependências específicas de teste da biblioteca:

      python -m pip install .[tests]
      
    3. Execute os testes de unidade para garantir que a biblioteca esteja funcionando corretamente:

      nox
      
    4. Opcional: os testes de unidade também podem ser executados usando o Docker. Primeiro, é preciso ter o Docker instalado. Em seguida, no diretório google-ads-python, execute o seguinte:

      docker build -t google-ads-python:test .
      docker run -it google-ads-python:test nox