Scrapybara Python Library
The Scrapybara Python library provides convenient access to the Scrapybara API from Python.
Installation
pip install scrapybara
Reference
Please refer to docs for more information.
Usage
Instantiate and use the client with the following:
from scrapybara import Scrapybara
client = Scrapybara(
api_key="YOUR_API_KEY",
)
client.start_ubuntu()
Async Client
The SDK also exports an async client so that you can make non-blocking calls to our API.
import asyncio
from scrapybara import AsyncScrapybara
client = AsyncScrapybara(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.start_ubuntu()
asyncio.run(main())
Exception Handling
When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.
from scrapybara.core.api_error import ApiError
try:
client.start_ubuntu()
except ApiError as e:
print(e.status_code)
print(e.body)
Advanced
Retries
The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retriable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).
A request is deemed retriable when any of the following HTTP status codes is returned:
Use the max_retries request option to configure this behavior.
client.start_ubuntu(..., request_options={
"max_retries": 1
})
Timeouts
The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
from scrapybara import Scrapybara
client = Scrapybara(
...,
timeout=20.0,
)
# Override timeout for a specific method
client.start_ubuntu(..., request_options={
"timeout_in_seconds": 1
})
Custom Client
You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies
and transports.
import httpx
from scrapybara import Scrapybara
client = Scrapybara(
...,
httpx_client=httpx.Client(
proxies="http://my.test.proxy.example.com",
transport=httpx.HTTPTransport(local_address="0.0.0.0"),
),
)
Contributing
While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!
1 maintainer
Metadata
1 maintainer
Release files for scrapybara 2.5.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| scrapybara-2.5.3.tar.gz | 45.3 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| scrapybara-2.5.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 120.8 kB
Release files / scrapybara-2.5.3.tar.gz
| Download URL | scrapybara-2.5.3.tar.gz |
|---|---|
| Size | 45.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
678de0997057943108575d9e4df73eb2da91af106d5bce86400b9b2f37f26e60
|
|
BLAKE2b-256 checksum How to use checksums |
911dbe5370ee00db637d572fd65ffe2e325a5e9bc9210f712a3d1cc650999c6b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.8.18 Linux/6.8.0-1027-azure
|
Release files / scrapybara-2.5.3-py3-none-any.whl
| Download URL | scrapybara-2.5.3-py3-none-any.whl |
|---|---|
| Size | 75.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5124ee23b9dec506393615ac1d37599d610cab6e657bc623e9708ff46e609cec
|
|
BLAKE2b-256 checksum How to use checksums |
90ebe5b00cecf54a296e0629cd103c685cd6eae387a350463bf8fc6160743444
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.8.18 Linux/6.8.0-1027-azure
|
Security for scrapybara 2.5.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
