scrape-do-python 0.1.0__tar.gz

scrape_do_python-0.1.0/LICENSE

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

scrape_do_python-0.1.0/PKG-INFO

@@ -0,0 +1,134 @@
+Metadata-Version: 2.4
+Name: scrape-do-python
+Version: 0.1.0
+Summary: A Python SDK for the Scrape.do API
+Author-email: svdC1 <svdc1mail@gmail.com>
+License: MIT
+Project-URL: Documentation, https://svdc1.github.io/scrape-do-python
+Project-URL: Repository, https://github.com/svdC1/scrape-do-python
+Project-URL: Issues, https://github.com/svdC1/scrape-do-python/issues
+Project-URL: Changelog, https://github.com/svdC1/scrape-do-python/blob/main/.github/CHANGELOG.md
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: respx; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs; extra == "docs"
+Requires-Dist: mkdocs-material; extra == "docs"
+Requires-Dist: mkdocstrings; extra == "docs"
+Requires-Dist: mkdocstrings-python; extra == "docs"
+Requires-Dist: mkdocs-autorefs; extra == "docs"
+Requires-Dist: black; extra == "docs"
+Dynamic: license-file
+
+[![PyPI](https://img.shields.io/pypi/v/scrape-do-python?style=flat&logo=pypi&logoColor=white)](https://pypi.org/project/scrape-do-python/)
+[![Python](https://img.shields.io/pypi/pyversions/scrape-do-python?style=flat&logo=python&logoColor=white)](https://pypi.org/project/scrape-do-python/)
+[![License](https://img.shields.io/badge/license-MIT-green?style=flat)](LICENSE)
+[![Docs](https://img.shields.io/badge/docs-lightgrey?style=flat&logo=materialformkdocs&logoColor=black&logoSize=auto)](https://svdc1.github.io/scrape-do-python)
+[![codecov](https://img.shields.io/codecov/c/github/svdC1/scrape-do-python?flag=unit&style=flat&logo=codecov&label=unit)](https://app.codecov.io/gh/svdC1/scrape-do-python?flags%5B0%5D=unit)
+[![codecov](https://img.shields.io/codecov/c/github/svdC1/scrape-do-python?flag=integration&style=flat&logo=codecov&label=integration)](https://app.codecov.io/gh/svdC1/scrape-do-python?flags%5B0%5D=integration)
+
+# scrape-do-python
+
+A Python SDK for the [`Scrape.do`](https://scrape.do) web-scraping proxy API.
+
+Built on [`httpx`](https://github.com/encode/httpx) and [`pydantic v2`](https://github.com/pydantic/pydantic), with strict request validation, automatic retries on gateway errors, sticky-session validation, and SDK-native lifecycle hooks.
+
+## Status
+> `v0.1.0` &rarr; Early but functional
+
+> Synchronous client is shipped
+
+> Async and Proxy-Mode clients are on the [`Roadmap`](.github/ROADMAP.md)
+
+> Breaking changes are possible between `0.x` minor versions.
+
+## Installation
+
+```bash
+pip install scrape-do-python
+```
+
+## Quickstart
+
+```python
+from scrape_do.client import ScrapeDoClient
+
+# API Token pulled from SCRAPE_DO_API_KEY env variable
+# Can also be provided via 'api_token' argument
+
+with ScrapeDoClient() as client:
+    response = client.get(
+        "https://example.com",
+        super=True,
+        render=True,
+        return_json=True,
+        show_frames=True,
+        )
+    
+    print(response.is_proxy_error)
+
+    print(response.frames[0].url)
+    
+    print(response.remaining_credits)
+```
+
+## Features
+
+### Type-Checked Request Parameters
+
+Request parameters are fully type-checked and automatically validated via the [`RequestParameters`](https://svdc1.github.io/scrape-do-python/models/parameters/#scrape_do.models.parameters.RequestParameters) pydantic model
+
+### Smart Routing
+[`ScrapeDoClient.request()`](https://svdc1.github.io/scrape-do-python/client/#scrape_do.client.ScrapeDoClient.request) accepts either `**api_kwargs`, a pre-built `RequestParameters`, or a raw `api.scrape.do` URL for request parameters
+
+### Automatic Retries
+
+[`ScrapeDoClient`]((https://svdc1.github.io/scrape-do-python/client/#scrape_do.client.ScrapeDoClient.session_validator)) can automatically retry requests on Scrape.do gateway errors (`429` / `502` / `510`) with `customizable backoff` (static or callable) 
+
+### Sticky-Session Validation
+
+Supply a [`session_validator`](https://svdc1.github.io/scrape-do-python/client/#scrape_do.client.SyncSessionValidator) callback to detect proxy node rotations and raise [`RotatedSessionError`](https://svdc1.github.io/scrape-do-python/exceptions/#scrape_do.exceptions.RotatedSessionError)
+
+### SDK-Native Event Hooks
+
+[`request / response / retry`](https://svdc1.github.io/scrape-do-python/client/#scrape_do.client.SyncClientEventHooks) lifecycle hooks, distinct from httpx's transport-level hooks.
+
+### Strongly-Typed Responses
+
+[`ScrapeDoResponse`](https://svdc1.github.io/scrape-do-python/models/response/#scrape_do.models.response.ScrapeDoResponse) exposes the parsed JSON envelope, browser action results, screenshots, and network/websocket logs.
+
+### Browser Automation
+
+Pydantic models for [`Browser Actions`](https://svdc1.github.io/scrape-do-python/models/browser_actions/) providing validation and type-hinting for the `playWithBrowser` API parameter
+
+## Documentation
+
+[`Full API Reference`](https://svdc1.github.io/scrape-do-python)
+
+## Roadmap
+
+See [`ROADMAP`](.github/ROADMAP.md) for the upcoming `Async Client`, `Proxy-Mode Clients`, `Async-API Support`, and `Plugin Support`
+
+## Contributing
+
+Pull Requests, Bug Reports, and Feature Requests are all welcome.
+
+See [`CONTRIBUTING`](.github/CONTRIBUTING.md) for local setup, test commands, and PR conventions
+
+## Community
+
+Participation is governed by our [`Code of Conduct`](.github/CODE_OF_CONDUCT.md). To privately report a security issue, see the [`Security Policy`](.github/SECURITY.md).
+
+## License
+
+`scrape-do-python` is released under the [`MIT License`](LICENSE)

scrape_do_python-0.1.0/README.md

@@ -0,0 +1,102 @@
+[![PyPI](https://img.shields.io/pypi/v/scrape-do-python?style=flat&logo=pypi&logoColor=white)](https://pypi.org/project/scrape-do-python/)
+[![Python](https://img.shields.io/pypi/pyversions/scrape-do-python?style=flat&logo=python&logoColor=white)](https://pypi.org/project/scrape-do-python/)
+[![License](https://img.shields.io/badge/license-MIT-green?style=flat)](LICENSE)
+[![Docs](https://img.shields.io/badge/docs-lightgrey?style=flat&logo=materialformkdocs&logoColor=black&logoSize=auto)](https://svdc1.github.io/scrape-do-python)
+[![codecov](https://img.shields.io/codecov/c/github/svdC1/scrape-do-python?flag=unit&style=flat&logo=codecov&label=unit)](https://app.codecov.io/gh/svdC1/scrape-do-python?flags%5B0%5D=unit)
+[![codecov](https://img.shields.io/codecov/c/github/svdC1/scrape-do-python?flag=integration&style=flat&logo=codecov&label=integration)](https://app.codecov.io/gh/svdC1/scrape-do-python?flags%5B0%5D=integration)
+
+# scrape-do-python
+
+A Python SDK for the [`Scrape.do`](https://scrape.do) web-scraping proxy API.
+
+Built on [`httpx`](https://github.com/encode/httpx) and [`pydantic v2`](https://github.com/pydantic/pydantic), with strict request validation, automatic retries on gateway errors, sticky-session validation, and SDK-native lifecycle hooks.
+
+## Status
+> `v0.1.0` → Early but functional
+
+> Synchronous client is shipped
+
+> Async and Proxy-Mode clients are on the [`Roadmap`](.github/ROADMAP.md)
+
+> Breaking changes are possible between `0.x` minor versions.
+
+## Installation
+
+```bash
+pip install scrape-do-python
+```
+
+## Quickstart
+
+```python
+from scrape_do.client import ScrapeDoClient
+
+# API Token pulled from SCRAPE_DO_API_KEY env variable
+# Can also be provided via 'api_token' argument
+
+with ScrapeDoClient() as client:
+    response = client.get(
+        "https://example.com",
+        super=True,
+        render=True,
+        return_json=True,
+        show_frames=True,
+        )
+    
+    print(response.is_proxy_error)
+
+    print(response.frames[0].url)
+    
+    print(response.remaining_credits)
+```
+
+## Features
+
+### Type-Checked Request Parameters
+
+Request parameters are fully type-checked and automatically validated via the [`RequestParameters`](https://svdc1.github.io/scrape-do-python/models/parameters/#scrape_do.models.parameters.RequestParameters) pydantic model
+
+### Smart Routing
+[`ScrapeDoClient.request()`](https://svdc1.github.io/scrape-do-python/client/#scrape_do.client.ScrapeDoClient.request) accepts either `**api_kwargs`, a pre-built `RequestParameters`, or a raw `api.scrape.do` URL for request parameters
+
+### Automatic Retries
+
+[`ScrapeDoClient`]((https://svdc1.github.io/scrape-do-python/client/#scrape_do.client.ScrapeDoClient.session_validator)) can automatically retry requests on Scrape.do gateway errors (`429` / `502` / `510`) with `customizable backoff` (static or callable) 
+
+### Sticky-Session Validation
+
+Supply a [`session_validator`](https://svdc1.github.io/scrape-do-python/client/#scrape_do.client.SyncSessionValidator) callback to detect proxy node rotations and raise [`RotatedSessionError`](https://svdc1.github.io/scrape-do-python/exceptions/#scrape_do.exceptions.RotatedSessionError)
+
+### SDK-Native Event Hooks
+
+[`request / response / retry`](https://svdc1.github.io/scrape-do-python/client/#scrape_do.client.SyncClientEventHooks) lifecycle hooks, distinct from httpx's transport-level hooks.
+
+### Strongly-Typed Responses
+
+[`ScrapeDoResponse`](https://svdc1.github.io/scrape-do-python/models/response/#scrape_do.models.response.ScrapeDoResponse) exposes the parsed JSON envelope, browser action results, screenshots, and network/websocket logs.
+
+### Browser Automation
+
+Pydantic models for [`Browser Actions`](https://svdc1.github.io/scrape-do-python/models/browser_actions/) providing validation and type-hinting for the `playWithBrowser` API parameter
+
+## Documentation
+
+[`Full API Reference`](https://svdc1.github.io/scrape-do-python)
+
+## Roadmap
+
+See [`ROADMAP`](.github/ROADMAP.md) for the upcoming `Async Client`, `Proxy-Mode Clients`, `Async-API Support`, and `Plugin Support`
+
+## Contributing
+
+Pull Requests, Bug Reports, and Feature Requests are all welcome.
+
+See [`CONTRIBUTING`](.github/CONTRIBUTING.md) for local setup, test commands, and PR conventions
+
+## Community
+
+Participation is governed by our [`Code of Conduct`](.github/CODE_OF_CONDUCT.md). To privately report a security issue, see the [`Security Policy`](.github/SECURITY.md).
+
+## License
+
+`scrape-do-python` is released under the [`MIT License`](LICENSE)

scrape_do_python-0.1.0/pyproject.toml

@@ -0,0 +1,76 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "scrape-do-python"
+version = "0.1.0"
+description = "A Python SDK for the Scrape.do API"
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "MIT" }
+authors = [
+    { name = "svdC1", email = "svdc1mail@gmail.com" }
+]
+dependencies = [
+    "httpx>=0.25.0",
+    "pydantic>=2.0.0"
+]
+
+[project.urls]
+Documentation = "https://svdc1.github.io/scrape-do-python"
+Repository = "https://github.com/svdC1/scrape-do-python"
+Issues = "https://github.com/svdC1/scrape-do-python/issues"
+Changelog = "https://github.com/svdC1/scrape-do-python/blob/main/.github/CHANGELOG.md"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov",
+    "pytest-mock",
+    "pytest-asyncio",
+    "respx",
+    "mypy",
+    "ruff"
+]
+
+docs = [
+    "mkdocs",
+    "mkdocs-material",
+    "mkdocstrings",
+    "mkdocstrings-python",
+    "mkdocs-autorefs",
+    "black"
+    ]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+markers = [
+    "unit: marks tests as unit tests",
+    "integration: marks tests as integration tests",
+]
+
+[tool.coverage.run]
+branch = true
+source = ["scrape_do"]
+relative_files = true
+
+[tool.coverage.paths]
+source = [
+    "src/scrape_do",
+    "*/site-packages/scrape_do",
+]
+
+[tool.coverage.report]
+show_missing = true
+skip_covered = false
+precision = 2
+exclude_lines = [
+    "pragma: no cover",
+    "raise NotImplementedError",
+    "if TYPE_CHECKING:",
+    "if __name__ == .__main__.:",
+    "@(abc\\.)?abstractmethod",
+]

scrape_do_python-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+