Installation

Que vous installiez la bibliothèque à partir de PyPI ou que vous la cloniez à partir de GitHub, nous vous recommandons de suivre les étapes ci-dessous à l'aide d'un environnement virtuel actif. Pour savoir comment créer et activer un environnement virtuel, consultez la documentation Environnement virtuel.

Installer le module à partir de PyPI

La bibliothèque est distribuée sur PyPI et peut être installée à l'aide de pip avec la commande suivante :

python -m pip install google-ads

Installer la bibliothèque depuis GitHub

Le code source de la bibliothèque peut être cloné depuis GitHub sur votre ordinateur local. Il est utile de cloner le code source pour exécuter facilement les exemples ou développer la bibliothèque elle-même. Pour information, l'exécution de l'un des exemples d'authentification est une étape obligatoire pour configurer la bibliothèque.

  1. Assurez-vous que python3.8 ou version ultérieure est présent dans votre environnement. Le moyen le plus simple consiste à utiliser pyenv :

    pyenv local 3.8
  2. Clonez la bibliothèque cliente depuis GitHub :

    git clone git@github.com:googleads/google-ads-python.git
  3. Accédez au dépôt et installez-le :

    cd google-ads-python
    python -m pip install .
  4. Si vous prévoyez de développer la bibliothèque, exécutez les tests unitaires avant et après avoir apporté des modifications :

    1. Assurez-vous que toutes les versions compatibles du langage Python sont disponibles dans votre environnement. Utiliser pyenv :

      pyenv local 3.8 3.9 3.10 3.11 3.12
    2. Installez les dépendances spécifiques aux tests de la bibliothèque :

      python -m pip install .[tests]
    3. Exécutez les tests unitaires pour vous assurer que la bibliothèque fonctionne correctement :

      nox
    4. Facultatif : les tests unitaires peuvent également être exécutés à l'aide de Docker. Tout d'abord, vous devez installer Docker. Ensuite, à partir du répertoire google-ads-python, exécutez la commande suivante :

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