התקנה

בין אם אתם מתקינים את הספרייה מ-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