snapshot-site-sdk 0.1.0

Official Python SDK for the Snapshot Site API

Snapshot Site Python SDK

Official Python SDK for the Snapshot Site API.

Install

pip install snapshot-site-sdk

Create your API token in Snapshot Site Console:

• https://console.snapshot-site.com

Usage

from snapshot_site import SnapshotSiteClient

client = SnapshotSiteClient(api_key="ss_live_xxx")

result = client.screenshot({
    "url": "https://snapshot-site.com",
    "format": "png",
    "fullSize": True,
})

print(result.get("link"))

Screenshot example

from snapshot_site import SnapshotSiteClient

client = SnapshotSiteClient(api_key="ss_live_xxx")

result = client.screenshot({
    "url": "https://snapshot-site.com/pricing",
    "width": 1440,
    "format": "png",
    "fullSize": True,
    "hideCookie": True,
})

print(result)

Analyze example

from snapshot_site import SnapshotSiteClient

client = SnapshotSiteClient(api_key="ss_live_xxx")

result = client.analyze({
    "url": "https://snapshot-site.com",
    "width": 1440,
    "fullSize": True,
    "enableSummary": True,
    "enableQuality": True,
})

print(result)

Compare example

from snapshot_site import SnapshotSiteClient

client = SnapshotSiteClient(api_key="ss_live_xxx")

result = client.compare({
    "before": {
        "url": "https://snapshot-site.com/pricing",
        "width": 1440,
        "fullSize": True,
        "hideCookie": True,
    },
    "after": {
        "url": "https://staging.snapshot-site.com/pricing",
        "width": 1440,
        "fullSize": True,
        "hideCookie": True,
    },
    "threshold": 0.1,
})

print(result)

Download assets locally

from snapshot_site import SnapshotSiteClient

client = SnapshotSiteClient(api_key="ss_live_xxx")

result = client.screenshot({
    "url": "https://snapshot-site.com/pricing",
    "format": "png",
    "fullSize": True,
})

client.download_to(result, "pricing.png")

Custom base URL

client = SnapshotSiteClient(
    api_key="ss_live_xxx",
    base_url="https://api.prod.ss.snapshot-site.com",
)

Tests

python -m pip install -e .[dev]
pytest

Build for PyPI

python -m pip install -e .[dev]
python -m build