نصب و راه اندازی

چه در حال نصب کتابخانه از 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. اطمینان حاصل کنید که تمام نسخه های پشتیبانی شده از زبان پایتون را در محیط خود در دسترس دارید. استفاده از 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