Lex-2008 / python-gtmetrix2

A Python client library for GTmetrix REST API v2.0

python-gtmetrix2

python-gtmetrix2 is a Python client library for GTmetrix REST API v2.0 (hence 2 in the name).

Inspired by the library with a similar name.

Installation:

via pip

pip install python-gtmetrix2

manual

• Clone or download and extract the repository
• Copy the src/python-gtmetrix2 directory to your project directory

Usage:

Simplest example:

import json
import python_gtmetrix2

api_key = "e8ddc55d93eb0e8281b255ea236dcc4f"    # your API key
url = "http://example.com"                      # URL to test

account = python_gtmetrix2.Account(api_key)     # init
test = account.start_test(url)                  # start test
test.fetch(wait_for_completion=True)            # wait for it to finish
report = test.getreport()                       # get test result

print(json.dumps(report, indent=2))             # do something useful with it

For a wordy introduction into this library, or a more technical explanation, dive into the docs

Versioning:

This project follows semver versioning scheme. Note that according to the semver, as long as the version number starts with 0, no guarantees regarding compatibility are given. Hence, when anyone starts using this library, please let the author know about it, so we can bump version number to one and "freeze" API compatibility.