spyglass-sdk 0.1.2__tar.gz

spyglass_sdk-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Spyglass
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

spyglass_sdk-0.1.2/PKG-INFO

@@ -0,0 +1,231 @@
+Metadata-Version: 2.1
+Name: spyglass-sdk
+Version: 0.1.2
+Summary: 
+Requires-Python: >=3.10,<4.0
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Provides-Extra: aiohttp
+Requires-Dist: aiohttp (>=3.14.1,<4) ; (python_version >= "3.10") and (extra == "aiohttp")
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: httpx-aiohttp (>=0.1.8,<0.2.0) ; (python_version >= "3.10") and (extra == "aiohttp")
+Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: pydantic-core (>=2.18.2,<3.0.0)
+Requires-Dist: typing_extensions (>=4.0.0)
+Project-URL: Repository, https://github.com/spyglass-so/spyglass-python
+Description-Content-Type: text/markdown
+
+<div align="center">
+  <img src="https://raw.githubusercontent.com/spyglass-so/spyglass-python/main/assets/wordmark.svg" alt="Spyglass" width="360">
+
+  <h3>The API layer for the social internet</h3>
+  <p>Official Python SDK for the Spyglass API — search brands, creators, and the ads they run.</p>
+
+  <a href="https://app.spyglass.so">
+    <img src="https://img.shields.io/badge/Get_Started-111111?style=for-the-badge" alt="Get Started">
+  </a>
+  <a href="https://docs.spyglass.so">
+    <img src="https://img.shields.io/badge/Documentation-4A4A4A?style=for-the-badge" alt="Documentation">
+  </a>
+  <a href="https://spyglass.so">
+    <img src="https://img.shields.io/badge/spyglass.so-0A0A0A?style=for-the-badge" alt="spyglass.so">
+  </a>
+</div>
+
+<br>
+
+<div align="center">
+  <a href="https://github.com/spyglass-so/spyglass-python/blob/main/LICENSE">
+    <img src="https://img.shields.io/github/license/spyglass-so/spyglass-python" alt="License">
+  </a>
+  <a href="https://github.com/spyglass-so/spyglass-python/stargazers">
+    <img src="https://img.shields.io/github/stars/spyglass-so/spyglass-python?style=social" alt="Stars">
+  </a>
+  <a href="https://pypi.org/project/spyglass-sdk/">
+    <img src="https://img.shields.io/pypi/v/spyglass-sdk" alt="PyPI">
+  </a>
+  <a href="https://github.com/spyglass-so/spyglass-typescript">
+    <img src="https://img.shields.io/badge/TypeScript_SDK-%40spyglasshq%2Fsdk-3178C6?logo=typescript&logoColor=white" alt="TypeScript SDK">
+  </a>
+</div>
+
+---
+
+**`spyglass-sdk`** is the official Python client for the [Spyglass API](https://docs.spyglass.so) with both synchronous (`Spyglass`) and asynchronous (`AsyncSpyglass`) clients. Resolve brands and creators, search across millions of Meta, Instagram, and TikTok creatives with natural-language briefs or structured filters, and extract hooks, personas, landing pages, and public comments.
+
+> Looking for TypeScript / Node.js? See [`spyglass-so/spyglass-typescript`](https://github.com/spyglass-so/spyglass-typescript) (`npm install @spyglasshq/sdk`).
+
+## Installation
+
+```bash
+pip install spyglass-sdk
+# or
+uv add spyglass-sdk
+```
+
+## Quickstart
+
+Create an API key in **[Settings → API](https://app.spyglass.so)**. Keys start with `sg_live_` and are shown once.
+
+```python
+import os
+from spyglass import Spyglass
+
+client = Spyglass(token=os.environ["SPYGLASS_API_KEY"])
+
+# 1. Resolve a brand
+result = client.search.brands(names=["Nike"], limit=1)
+
+if result.brands:
+    brand = result.brands[0]
+
+    # 2. Search the creatives that brand is running
+    media_result = client.search.get_media(
+        brand_id=brand.id,
+        query="marathon running shoes comfort",
+        limit=10,
+    )
+
+    for ad in media_result.media:
+        print(ad.id, ad.hook, ad.core_angle, ad.url)
+```
+
+## Async Usage
+
+Use `AsyncSpyglass` for non-blocking calls with `asyncio`:
+
+```python
+import asyncio
+import os
+from spyglass import AsyncSpyglass
+
+client = AsyncSpyglass(token=os.environ["SPYGLASS_API_KEY"])
+
+
+async def main() -> None:
+    result = await client.search.brands(names=["Nike"], limit=3)
+    for brand in result.brands:
+        print(brand.id, brand.name)
+
+
+asyncio.run(main())
+```
+
+## API Reference Overview
+
+| SDK Method | HTTP Endpoint | Cost | Rate Limit |
+| --- | --- | --- | --- |
+| `client.search.brands(...)` | `POST /brands` | $0.0020 / brand returned | 120 / min |
+| `client.search.creators(...)` | `POST /creators` | $0.0020 / creator returned | 120 / min |
+| `client.search.get_account(id=...)` | `GET /account/{id}` | $0.0020 / account returned | 120 / min |
+| `client.search.get_media(...)` | `POST /media` | $0.0010 / creative returned | 120 / min |
+| `client.search.taxonomies(query=...)` | `GET /taxonomies` | Free | 120 / min |
+| `client.search.get_brand_media_insights(...)` | `GET /account/{id}/insights` | $0.0010 / cluster returned | 120 / min |
+| `client.search.get_brand_landing_pages(...)` | `GET /account/{id}/landing-pages` | $0.0050 / landing page returned | 120 / min |
+| `client.search.get_comments(...)` | `POST /comments` | $0.0100 / live page fetched | 20 / min |
+| `client.indexing.index_brand(...)` | `POST /account/index` | Free | 50 / min |
+| `client.indexing.index_brand_status(id=...)` | `GET /account/{id}/index-status` | Free | 300 / min |
+| `client.account.get_credit_usage()` | `GET /team/credit-usage` | Free | 120 / min |
+
+Full parameters and response schemas are documented in [`reference.md`](https://github.com/spyglass-so/spyglass-python/blob/main/reference.md) and at [docs.spyglass.so](https://docs.spyglass.so).
+
+## Indexing a New Brand
+
+If Spyglass doesn't have a brand yet, queue it by website or social profile URL (`POST /account/index` is free) and poll until `status` is `"ready"`:
+
+```python
+import time
+
+indexed = client.indexing.index_brand(website_url="https://www.on.com")
+
+status = indexed.status
+while status == "indexing":
+    time.sleep(3)
+    check = client.indexing.index_brand_status(id=indexed.brand_id)
+    status = check.status
+```
+
+## Error Handling
+
+Non-2xx responses raise an `ApiError` with status code and parsed error body:
+
+```python
+from spyglass.core.api_error import ApiError
+
+try:
+    client.search.brands(names=["Nike"], limit=5)
+except ApiError as e:
+    print(e.status_code, e.body)
+```
+
+## Advanced Options
+
+### Retries & Timeouts
+
+Requests default to a 60-second timeout and up to 2 automatic retries with exponential backoff on `408`, `409`, `429`, and `5xx` responses. Override at the client or per-request level:
+
+```python
+client = Spyglass(token="...", timeout=30.0, max_retries=3)
+
+response = client.search.brands(
+    names=["Nike"],
+    limit=5,
+    request_options={"timeout_in_seconds": 15, "max_retries": 1},
+)
+```
+
+### Raw Response & Headers
+
+Use `.with_raw_response` to inspect HTTP headers and status codes:
+
+```python
+raw = client.search.with_raw_response.brands(names=["Nike"], limit=1)
+print(raw.status_code)
+print(raw.headers)
+print(raw.data.brands)
+```
+
+### Custom HTTPX Client
+
+Pass a custom `httpx.Client` or `httpx.AsyncClient` for custom proxies or transport settings:
+
+```python
+import httpx
+from spyglass import Spyglass
+
+client = Spyglass(
+    token="...",
+    httpx_client=httpx.Client(proxy="http://proxy.example.com"),
+)
+```
+
+## Billing & Conventions
+
+- **Credits:** Most calls spend monthly credits per row returned (`count` in the response). Always bound requests with `limit`. See [Billing docs](https://docs.spyglass.so/documentation/get-started/billing).
+- **Pagination:** Page through results with `offset` and `limit`. `count` is the number of rows in the current response.
+- **Server-to-server:** Call the API from your backend, data pipeline, or agent runtime.
+
+## Support
+
+- **Documentation:** [docs.spyglass.so](https://docs.spyglass.so)
+- **Issues:** [github.com/spyglass-so/spyglass-python/issues](https://github.com/spyglass-so/spyglass-python/issues)
+- **Email:** [support@spyglass.so](mailto:support@spyglass.so)
+
+## License
+
+[MIT](https://github.com/spyglass-so/spyglass-python/blob/main/LICENSE)
+

spyglass_sdk-0.1.2/README.md

@@ -0,0 +1,199 @@
+<div align="center">
+  <img src="https://raw.githubusercontent.com/spyglass-so/spyglass-python/main/assets/wordmark.svg" alt="Spyglass" width="360">
+
+  <h3>The API layer for the social internet</h3>
+  <p>Official Python SDK for the Spyglass API — search brands, creators, and the ads they run.</p>
+
+  <a href="https://app.spyglass.so">
+    <img src="https://img.shields.io/badge/Get_Started-111111?style=for-the-badge" alt="Get Started">
+  </a>
+  <a href="https://docs.spyglass.so">
+    <img src="https://img.shields.io/badge/Documentation-4A4A4A?style=for-the-badge" alt="Documentation">
+  </a>
+  <a href="https://spyglass.so">
+    <img src="https://img.shields.io/badge/spyglass.so-0A0A0A?style=for-the-badge" alt="spyglass.so">
+  </a>
+</div>
+
+<br>
+
+<div align="center">
+  <a href="https://github.com/spyglass-so/spyglass-python/blob/main/LICENSE">
+    <img src="https://img.shields.io/github/license/spyglass-so/spyglass-python" alt="License">
+  </a>
+  <a href="https://github.com/spyglass-so/spyglass-python/stargazers">
+    <img src="https://img.shields.io/github/stars/spyglass-so/spyglass-python?style=social" alt="Stars">
+  </a>
+  <a href="https://pypi.org/project/spyglass-sdk/">
+    <img src="https://img.shields.io/pypi/v/spyglass-sdk" alt="PyPI">
+  </a>
+  <a href="https://github.com/spyglass-so/spyglass-typescript">
+    <img src="https://img.shields.io/badge/TypeScript_SDK-%40spyglasshq%2Fsdk-3178C6?logo=typescript&logoColor=white" alt="TypeScript SDK">
+  </a>
+</div>
+
+---
+
+**`spyglass-sdk`** is the official Python client for the [Spyglass API](https://docs.spyglass.so) with both synchronous (`Spyglass`) and asynchronous (`AsyncSpyglass`) clients. Resolve brands and creators, search across millions of Meta, Instagram, and TikTok creatives with natural-language briefs or structured filters, and extract hooks, personas, landing pages, and public comments.
+
+> Looking for TypeScript / Node.js? See [`spyglass-so/spyglass-typescript`](https://github.com/spyglass-so/spyglass-typescript) (`npm install @spyglasshq/sdk`).
+
+## Installation
+
+```bash
+pip install spyglass-sdk
+# or
+uv add spyglass-sdk
+```
+
+## Quickstart
+
+Create an API key in **[Settings → API](https://app.spyglass.so)**. Keys start with `sg_live_` and are shown once.
+
+```python
+import os
+from spyglass import Spyglass
+
+client = Spyglass(token=os.environ["SPYGLASS_API_KEY"])
+
+# 1. Resolve a brand
+result = client.search.brands(names=["Nike"], limit=1)
+
+if result.brands:
+    brand = result.brands[0]
+
+    # 2. Search the creatives that brand is running
+    media_result = client.search.get_media(
+        brand_id=brand.id,
+        query="marathon running shoes comfort",
+        limit=10,
+    )
+
+    for ad in media_result.media:
+        print(ad.id, ad.hook, ad.core_angle, ad.url)
+```
+
+## Async Usage
+
+Use `AsyncSpyglass` for non-blocking calls with `asyncio`:
+
+```python
+import asyncio
+import os
+from spyglass import AsyncSpyglass
+
+client = AsyncSpyglass(token=os.environ["SPYGLASS_API_KEY"])
+
+
+async def main() -> None:
+    result = await client.search.brands(names=["Nike"], limit=3)
+    for brand in result.brands:
+        print(brand.id, brand.name)
+
+
+asyncio.run(main())
+```
+
+## API Reference Overview
+
+| SDK Method | HTTP Endpoint | Cost | Rate Limit |
+| --- | --- | --- | --- |
+| `client.search.brands(...)` | `POST /brands` | $0.0020 / brand returned | 120 / min |
+| `client.search.creators(...)` | `POST /creators` | $0.0020 / creator returned | 120 / min |
+| `client.search.get_account(id=...)` | `GET /account/{id}` | $0.0020 / account returned | 120 / min |
+| `client.search.get_media(...)` | `POST /media` | $0.0010 / creative returned | 120 / min |
+| `client.search.taxonomies(query=...)` | `GET /taxonomies` | Free | 120 / min |
+| `client.search.get_brand_media_insights(...)` | `GET /account/{id}/insights` | $0.0010 / cluster returned | 120 / min |
+| `client.search.get_brand_landing_pages(...)` | `GET /account/{id}/landing-pages` | $0.0050 / landing page returned | 120 / min |
+| `client.search.get_comments(...)` | `POST /comments` | $0.0100 / live page fetched | 20 / min |
+| `client.indexing.index_brand(...)` | `POST /account/index` | Free | 50 / min |
+| `client.indexing.index_brand_status(id=...)` | `GET /account/{id}/index-status` | Free | 300 / min |
+| `client.account.get_credit_usage()` | `GET /team/credit-usage` | Free | 120 / min |
+
+Full parameters and response schemas are documented in [`reference.md`](https://github.com/spyglass-so/spyglass-python/blob/main/reference.md) and at [docs.spyglass.so](https://docs.spyglass.so).
+
+## Indexing a New Brand
+
+If Spyglass doesn't have a brand yet, queue it by website or social profile URL (`POST /account/index` is free) and poll until `status` is `"ready"`:
+
+```python
+import time
+
+indexed = client.indexing.index_brand(website_url="https://www.on.com")
+
+status = indexed.status
+while status == "indexing":
+    time.sleep(3)
+    check = client.indexing.index_brand_status(id=indexed.brand_id)
+    status = check.status
+```
+
+## Error Handling
+
+Non-2xx responses raise an `ApiError` with status code and parsed error body:
+
+```python
+from spyglass.core.api_error import ApiError
+
+try:
+    client.search.brands(names=["Nike"], limit=5)
+except ApiError as e:
+    print(e.status_code, e.body)
+```
+
+## Advanced Options
+
+### Retries & Timeouts
+
+Requests default to a 60-second timeout and up to 2 automatic retries with exponential backoff on `408`, `409`, `429`, and `5xx` responses. Override at the client or per-request level:
+
+```python
+client = Spyglass(token="...", timeout=30.0, max_retries=3)
+
+response = client.search.brands(
+    names=["Nike"],
+    limit=5,
+    request_options={"timeout_in_seconds": 15, "max_retries": 1},
+)
+```
+
+### Raw Response & Headers
+
+Use `.with_raw_response` to inspect HTTP headers and status codes:
+
+```python
+raw = client.search.with_raw_response.brands(names=["Nike"], limit=1)
+print(raw.status_code)
+print(raw.headers)
+print(raw.data.brands)
+```
+
+### Custom HTTPX Client
+
+Pass a custom `httpx.Client` or `httpx.AsyncClient` for custom proxies or transport settings:
+
+```python
+import httpx
+from spyglass import Spyglass
+
+client = Spyglass(
+    token="...",
+    httpx_client=httpx.Client(proxy="http://proxy.example.com"),
+)
+```
+
+## Billing & Conventions
+
+- **Credits:** Most calls spend monthly credits per row returned (`count` in the response). Always bound requests with `limit`. See [Billing docs](https://docs.spyglass.so/documentation/get-started/billing).
+- **Pagination:** Page through results with `offset` and `limit`. `count` is the number of rows in the current response.
+- **Server-to-server:** Call the API from your backend, data pipeline, or agent runtime.
+
+## Support
+
+- **Documentation:** [docs.spyglass.so](https://docs.spyglass.so)
+- **Issues:** [github.com/spyglass-so/spyglass-python/issues](https://github.com/spyglass-so/spyglass-python/issues)
+- **Email:** [support@spyglass.so](mailto:support@spyglass.so)
+
+## License
+
+[MIT](https://github.com/spyglass-so/spyglass-python/blob/main/LICENSE)

spyglass_sdk-0.1.2/pyproject.toml

@@ -0,0 +1,96 @@
+[project]
+name = "spyglass-sdk"
+dynamic = ["version"]
+
+[tool.poetry]
+name = "spyglass-sdk"
+version = "0.1.2"
+description = ""
+readme = "README.md"
+authors = []
+keywords = []
+classifiers = [
+    "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+    "Operating System :: OS Independent",
+    "Operating System :: POSIX",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: Microsoft :: Windows",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed"
+]
+packages = [
+    { include = "spyglass", from = "src"}
+]
+
+[tool.poetry.urls]
+Repository = 'https://github.com/spyglass-so/spyglass-python'
+
+[tool.poetry.dependencies]
+python = "^3.10"
+aiohttp = { version = ">=3.14.1,<4", optional = true, python = ">=3.10"}
+httpx = ">=0.21.2"
+httpx-aiohttp = { version = "^0.1.8", optional = true, python = ">=3.10"}
+pydantic = ">= 1.9.2"
+pydantic-core = ">=2.18.2,<3.0.0"
+typing_extensions = ">= 4.0.0"
+
+[tool.poetry.group.dev.dependencies]
+mypy = "==1.13.0"
+pytest = "^9.0.3"
+pytest-asyncio = "^1.0.0"
+pytest-xdist = "^3.6.1"
+python-dateutil = "^2.9.0"
+types-python-dateutil = "^2.9.0.20240316"
+urllib3 = ">=2.6.3,<3.0.0"
+ruff = "==0.11.5"
+
+[tool.pytest.ini_options]
+testpaths = [ "tests" ]
+asyncio_mode = "auto"
+norecursedirs = [ "src" ]
+markers = [
+    "aiohttp: tests that require httpx_aiohttp to be installed",
+]
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle errors
+    "F",  # pyflakes
+    "I",  # isort
+]
+ignore = [
+    "E402",  # Module level import not at top of file
+    "E501",  # Line too long
+    "E711",  # Comparison to `None` should be `cond is not None`
+    "E712",  # Avoid equality comparisons to `True`; use `if ...:` checks
+    "E721",  # Use `is` and `is not` for type comparisons, or `isinstance()` for insinstance checks
+    "E722",  # Do not use bare `except`
+    "E731",  # Do not assign a `lambda` expression, use a `def`
+    "F821",  # Undefined name
+    "F841"   # Local variable ... is assigned to but never used
+]
+
+[tool.ruff.lint.isort]
+section-order = ["future", "standard-library", "third-party", "first-party"]
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.extras]
+aiohttp=["aiohttp", "httpx-aiohttp"]