Instalacja

Niezależnie od tego, czy instalujesz bibliotekę z PyPI, czy klonujesz ją z GitHuba, zalecamy wykonanie podanych niżej czynności w aktywnej wirtualnej maszynie. Informacje o tworzeniu i aktywowaniu środowiska wirtualnego znajdziesz w dokumentacji Środowisko wirtualne.

Instalowanie modułu z PyPI

Biblioteka jest rozpowszechniana na stronie PyPI i można ją zainstalować za pomocą pip, używając tego polecenia:

python -m pip install google-ads

Instalowanie biblioteki z GitHuba

Kod źródłowy biblioteki można sklonować z GitHub na komputer lokalny. Warto skopiować kod źródłowy, aby łatwo wykonywać przykłady lub rozwijać bibliotekę. Uruchomienie jednego z przykładów uwierzytelniania jest wymagane, aby móc skonfigurować bibliotekę do użycia.

  1. Upewnij się, że w Twoim środowisku jest dostępna wersja python3.8 lub nowsza. Najprostszym sposobem jest użycie pyenv:

    pyenv local 3.8
  2. Sklonuj bibliotekę klienta z GitHuba:

    git clone git@github.com:googleads/google-ads-python.git
  3. Wpisz repozytorium i zainstaluj je:

    cd google-ads-python
    python -m pip install .
  4. Jeśli zamierzasz rozwijać bibliotekę, przeprowadź testy jednostkowe przed wprowadzeniem zmian i po ich wprowadzeniu:

    1. Upewnij się, że w Twoim środowisku są dostępne wszystkie obsługiwane wersje języka Python. Używam pyenv:

      pyenv local 3.8 3.9 3.10 3.11 3.12
    2. Zainstaluj zależności biblioteki związane z testem:

      python -m pip install .[tests]
    3. Uruchom testy jednostkowe, aby sprawdzić, czy biblioteka działa prawidłowo:

      nox
    4. Opcjonalnie: testy jednostkowe można też uruchomić za pomocą Dockera. Najpierw musisz mieć zainstalowanego Dockera. Następnie w katalogu google-ads-python uruchom to polecenie:

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