התקנה

בין שאתם מתקינים את הספרייה מ-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 [e-mail]: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