crawlora 1.5.0.dev1__py3-none-any.whl

crawlora/py.typed

@@ -0,0 +1 @@
+

crawlora-1.5.0.dev1.dist-info/METADATA

@@ -0,0 +1,213 @@
+Metadata-Version: 2.4
+Name: crawlora
+Version: 1.5.0.dev1
+Summary: Python SDK for the public Crawlora API.
+Author: Crawlora
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Crawlora-org/crawlora-python-sdk
+Project-URL: Repository, https://github.com/Crawlora-org/crawlora-python-sdk
+Project-URL: Issues, https://github.com/Crawlora-org/crawlora-python-sdk/issues
+Keywords: crawlora,sdk,web-scraping,api-client
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typing-extensions>=4.8; python_version < "3.11"
+Provides-Extra: async
+Requires-Dist: httpx>=0.27; extra == "async"
+Dynamic: license-file
+
+# Crawlora Python SDK
+
+Python client for the public Crawlora API. Use it to call Crawlora scraping,
+search, marketplace, media, maps, finance, and usage endpoints with generated
+type stubs for editor and type-checker support.
+
+- Runtime: Python 3.10+
+- Auth: `x-api-key`
+- Default API base URL: `https://api.crawlora.net/api/v1`
+- Reference: [operations](docs/operations.md) and [recipes](docs/recipes.md)
+
+## Install
+
+The Python SDK is currently distributed from Git beta tags:
+
+```sh
+pip install "git+https://github.com/Crawlora-org/crawlora-python-sdk.git@latest"
+```
+
+For reproducible builds, pin a released tag:
+
+```sh
+pip install "git+https://github.com/Crawlora-org/crawlora-python-sdk.git@TAG"
+```
+
+## API Key
+
+Create or sign in to your Crawlora account at [crawlora.net](https://crawlora.net),
+then create an API key in the dashboard.
+
+```sh
+read -r CRAWLORA_API_KEY
+export CRAWLORA_API_KEY
+```
+
+## First Request
+
+```python
+import os
+from crawlora import CrawloraClient
+
+crawlora = CrawloraClient(api_key=os.environ["CRAWLORA_API_KEY"])
+
+response = crawlora.bing.search(
+    q="coffee shops",
+    count=10,
+)
+
+print(response["data"]["results"][0])
+```
+
+Endpoint groups are generated from the public API contract, so common calls are
+available as methods such as `crawlora.bing.search(...)`,
+`crawlora.youtube.transcript(...)`, and `crawlora.google.map_search(...)`.
+
+## Typed Dynamic Calls
+
+You can also call by operation id. Literal operation ids are covered by the
+generated `.pyi` stubs, so type checkers can infer the matching parameter and
+response aliases:
+
+```python
+response = crawlora.request("bing-search", {
+    "q": "coffee shops",
+    "count": 10,
+})
+```
+
+Generated stubs include operation ids, endpoint groups, keyword parameters,
+enum values, response aliases, and reserved request options.
+
+## Configuration
+
+```python
+crawlora = CrawloraClient(
+    api_key=os.environ["CRAWLORA_API_KEY"],
+    base_url="https://api.crawlora.net/api/v1",
+    timeout=30,
+    retries=2,
+    retry_delay=0.25,
+    headers={"x-client": "my-app"},
+)
+```
+
+Per-request options are available through reserved keyword arguments. Header
+names are matched case-insensitively, so request headers can override default
+auth, user-agent, and content headers without duplicating variants such as
+`x-api-key` and `X-API-KEY`:
+
+```python
+response = crawlora.bing.search(
+    q="coffee shops",
+    _timeout=10,
+    _headers={"x-request-id": "search-001"},
+)
+```
+
+## Text Responses
+
+Most endpoints return JSON. `_response_type` must be `auto`, `json`, or
+`text`. Endpoints that support alternate text output, such as YouTube
+transcripts, can opt into text mode:
+
+```python
+transcript = crawlora.youtube.transcript(
+    id="VIDEO_ID",
+    format="text",
+    _response_type="text",
+)
+
+print(transcript)
+```
+
+## Errors
+
+Failed API calls raise `CrawloraError`:
+
+```python
+from crawlora import CrawloraError
+
+try:
+    crawlora.bing.search(q="coffee shops")
+except CrawloraError as error:
+    print(error.status, error.code, error.body)
+    raise
+```
+
+The error includes `status`, optional API `code`, parsed `body`, `raw_body`,
+response `headers`, and the underlying parser or transport exception as
+`__cause__` when available. Retryable responses honor positive `Retry-After`
+headers, capped at 30 seconds. Timeout-like transport failures use the
+`Crawlora request timed out` SDK message.
+
+`CrawloraError` has three subclasses for branching on the failure kind:
+`CrawloraClientError` (4xx, request rejected), `CrawloraServerError` (5xx), and
+`CrawloraNetworkError` (transport failure or timeout before a response).
+
+## Async
+
+`AsyncCrawloraClient` mirrors the synchronous client for asyncio applications:
+
+```python
+from crawlora import AsyncCrawloraClient
+
+crawlora = AsyncCrawloraClient(api_key="YOUR_API_KEY")
+result = await crawlora.bing.search(q="coffee shops")
+```
+
+It reuses the same validation, retries, and `Retry-After` handling, running each
+request in a worker thread so the package stays dependency-free.
+
+## Pagination
+
+`client.paginate` yields successive pages, advancing the page/offset query
+parameter and stopping when a page returns no data:
+
+```python
+for page in crawlora.paginate("ebay-seller-feedback", {"seller": "acme"}):
+    for review in page["data"]:
+        print(review)
+```
+
+`AsyncCrawloraClient.paginate` is the `async for` equivalent. Override detection
+with `page_param`, `start`, `step`, and `max_pages`.
+
+## Examples
+
+Runnable examples live under `examples/` and skip cleanly when required
+environment variables are missing:
+
+```sh
+python3 examples/bing_search.py
+python3 examples/youtube_transcript.py
+```
+
+Set `CRAWLORA_BASE_URL` to point examples at a staging or local API.
+
+## Package Notes
+
+The import name is `crawlora`:
+
+```python
+from crawlora import CrawloraClient
+```
+
+The future PyPI package target is also `crawlora`, but registry publication is
+not enabled yet. Until then, install from an explicit Git beta tag or the
+moving `latest` tag as shown above.

crawlora-1.5.0.dev1.dist-info/RECORD

@@ -0,0 +1,13 @@
+crawlora/__init__.py,sha256=6iBg2JTKRkQjm4fwoHcJ_s0vWRL1Z8jHuU9ttC_Movs,527
+crawlora/_pagination.py,sha256=EzD7JNJ4UpA-CnQOoXoXKQ0RFCOyNUQ7PQohz9VxDuM,1362
+crawlora/_transport_sync.py,sha256=Vel66LuNbN9S-lXLu5aYRzanHD3kGt61ukDu0NLqlPI,4294
+crawlora/async_client.py,sha256=tDX3WuQQUDBph84XpIlk2YHAAGRD5s66NMSzcH41TgY,13691
+crawlora/client.py,sha256=IV-MtaWnetnUgEI_ZgEAoV-kZPhie5CmKrVcesrlZyg,27244
+crawlora/client.pyi,sha256=pQjgADZG2Qjs-qAML20XgTTCd7vfep48Yc5H8P64F6k,812162
+crawlora/operations.py,sha256=7i8gprWKTnY1S03CSjQ4bKaLpyQqgHSJoKMAIdN2NLo,407101
+crawlora/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+crawlora-1.5.0.dev1.dist-info/licenses/LICENSE,sha256=AJCfINUOcsaheBDv_3ZGzXaEnoibR9-WgzVfXKXxeuQ,1065
+crawlora-1.5.0.dev1.dist-info/METADATA,sha256=mme0m4hVwCuHaTz3ScYBYLqTe_a0LmhvVyoi4lJ0Vd0,5970
+crawlora-1.5.0.dev1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+crawlora-1.5.0.dev1.dist-info/top_level.txt,sha256=1-n_HDMojz5VLZUwBTeXGo1QKAOnBLmKIo4cKwaoqcY,9
+crawlora-1.5.0.dev1.dist-info/RECORD,,

crawlora-1.5.0.dev1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

crawlora-1.5.0.dev1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Crawlora
+
+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.

crawlora-1.5.0.dev1.dist-info/top_level.txt

@@ -0,0 +1 @@
+crawlora