התקנה

בין אם אתם מתקינים את הספרייה מ-PyPI או משכפלים אותה מ-GitHub, מומלץ לבצע את השלבים הבאים באמצעות סביבה וירטואלית פעילה. מידע על יצירה והפעלה של סביבה וירטואלית זמין במאמר בנושא סביבה וירטואלית.

התקנת המודול מ-PyPI

הספרייה מופצת ב-PyPI ואפשר להתקין אותה באמצעות pip עם הפקודה הבאה:

python -m pip install google-ads

התקנת הספרייה מ-GitHub

אפשר לשכפל את קוד המקור של הספרייה מ-GitHub למחשב המקומי. מומלץ לשכפל את קוד המקור כדי להריץ בקלות את הדוגמאות או לפתח את הספרייה עצמה. לצורך העיון, הפעלת אחד מהדוגמאות לאימות היא שלב חובה בהגדרת הספרייה לשימוש.

  1. מוודאים שגרסה python3.8 ואילך קיימת בסביבה שלכם. הדרך הפשוטה ביותר היא באמצעות pyenv:

    pyenv local 3.8
  2. משכפלים את ספריית הלקוח מ-GitHub:

    git clone git@github.com:googleads/google-ads-python.git
  3. מזינים את המאגר ומתקינים אותו:

    cd google-ads-python
    python -m pip install .
  4. אם אתם מתכוונים לפתח את הספרייה, כדאי להריץ את בדיקות היחידה לפני ואחרי ביצוע שינויים:

    1. מוודאים שכל הגרסאות הנתמכות של שפת Python זמינות בסביבה שלכם. שימוש ב-pyenv::

      pyenv local 3.8 3.9 3.10 3.11 3.12
    2. מתקינים את יחסי התלות הספציפיים של הבדיקה בספרייה:

      python -m pip install .[tests]
    3. מריצים את בדיקות היחידה כדי לוודא שהספרייה פועלת כמו שצריך:

      nox
    4. אופציונלי: אפשר להריץ את בדיקות היחידה גם באמצעות Docker. קודם כול, צריך לוודא שDocker מותקן. לאחר מכן, מהספרייה google-ads-python, מריצים את הפקודה הבאה:

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