scrapely-client-python 1.0.3__py3-none-any.whl → 1.0.6__py3-none-any.whl

scrapely_client/_charging.py

@@ -1,12 +1,11 @@
 """Opt-in pay-per-event charging interception for dataset pushes.
 
-Port of ``scrapely-python``'s ``patched_apify_client.py`` semantics into the client
+Charging interception for dataset pushes, implemented in the client
 itself, with the charging logic supplied by the host SDK via the
 :class:`ChargingHooks` protocol (no SDK import — the SDK adapts its
 ``ChargingManager`` to these hooks later).
 
-Without hooks (the default), the client behaves exactly like stock
-``apify-client``.
+Without hooks (the default), dataset pushes are not intercepted.
 """
 
 from __future__ import annotations
@@ -126,7 +125,7 @@ def _merge_context_charge_result(context: PpeAwarePushDataContext, hooks: Chargi
 def wrap_dataset_client_with_charging(client: Any, hooks: ChargingHooks, *, is_async: bool) -> Any:
     """Wrap a dataset client's ``push_items`` with charging interception (method swap by design).
 
-    Semantics match ``scrapely``'s ``patched_apify_client.py``: normalize items →
+    Normalize items →
     ``push_and_charge`` with a ``push_fn`` that pushes the accepted subset via the
     original ``push_items``, and accumulate the charge result into the ambient
     ``push_data_charging_context`` when present.

scrapely_client/_consts.py

@@ -4,7 +4,7 @@ from __future__ import annotations
 
 from datetime import timedelta
 
-DEFAULT_API_URL = 'https://api-staging.scrape.ly'
+DEFAULT_API_URL = 'https://api.scrape.ly'
 """Default base URL for the Scrapely API."""
 
 API_VERSION = 'v2'

scrapely_client/_logging.py

@@ -110,7 +110,7 @@ def create_redirect_logger(name: str) -> logging.Logger:
     """Create a logger for redirecting logs from another Actor.
 
     Args:
-        name: Logger name. Use dot notation for hierarchy (e.g., "apify.xyz" creates "xyz" under "apify").
+        name: Logger name. Use dot notation for hierarchy (e.g., "scrapely.xyz" creates "xyz" under "scrapely").
 
     Returns:
         Configured logger with RedirectLogFormatter.

scrapely_client/_models.py

@@ -88,7 +88,7 @@ class Actor(BaseModel):
     """
     description: Annotated[str | None, Field(examples=['Extract data from hundreds of places fast.'])] = None
     """
-    Short description of the Actor, displayed in Scrapely Store and Console.
+    Short description of the Actor, displayed in Scrapely Store and dashboard.
     """
     restart_on_error: Annotated[bool | None, Field(deprecated=True, examples=[False])] = None
     is_public: Annotated[bool, Field(examples=[False])]
@@ -133,7 +133,7 @@ class Actor(BaseModel):
     """
     title: Annotated[str | None, Field(examples=['Google Search Extractor'])] = None
     """
-    Human-readable name of the Actor, displayed in Scrapely Store and Console.
+    Human-readable name of the Actor, displayed in Scrapely Store and dashboard.
     """
     tagged_builds: dict[str, TaggedBuildInfo | None] | None = None
     actor_standby: ActorStandby | None = None
@@ -143,7 +143,7 @@ class Actor(BaseModel):
     """
     seo_title: Annotated[str | None, Field(examples=['Web Scraper'])] = None
     """
-    Name of the Actor to display by search engines such as Google. Can be different from the Actor's name displayed in Scrapely Store and Console.
+    Name of the Actor to display by search engines such as Google. Can be different from the Actor's name displayed in Scrapely Store and dashboard.
     """
     seo_description: Annotated[
         str | None, Field(examples=['Crawls websites using Chrome and extracts data from pages using JavaScript.'])
@@ -152,12 +152,12 @@ class Actor(BaseModel):
     Description of the Actor to display by search engines such as Google.
     """
     picture_url: Annotated[
-        str | None, Field(examples=['https://apify-image-uploads-prod.s3.amazonaws.com/.../actor-picture.png'])
+        str | None, Field(examples=['https://images.scrape.ly/.../actor-picture.png'])
     ] = None
     """
-    URL of the Actor's icon, displayed on the Actor's page in Scrapely Store and Console.
+    URL of the Actor's icon, displayed on the Actor's page in Scrapely Store and dashboard.
     """
-    standby_url: Annotated[str | None, Field(examples=['https://jane35--my-actor.apify.actor'])] = None
+    standby_url: Annotated[str | None, Field(examples=['https://jane35--my-actor.scrape.ly'])] = None
     """
     URL for sending requests to the Actor in Standby mode.
     `null` if the Standby mode isn't enabled.
@@ -292,7 +292,7 @@ class ActorDefinition(BaseModel):
 
 @docs_group('Models')
 class ActorNotice(Enum):
-    """A warning displayed on the Actor's page in Scrapely Store and Console. Can be set by the Actor's developer or automatically by Scrapely's quality checks."""
+    """A warning displayed on the Actor's page in Scrapely Store and dashboard. Can be set by the Actor's developer or automatically by Scrapely's quality checks."""
 
     NONE = 'NONE'
     RESIDENTIAL_PROXY_REQUIRED = 'RESIDENTIAL_PROXY_REQUIRED'
@@ -454,7 +454,7 @@ class AddedRequest(BaseModel):
     """
     A unique identifier assigned to the request.
     """
-    unique_key: Annotated[str, Field(examples=['GET|60d83e70|e3b0c442|https://api-staging.scrape.ly'])]
+    unique_key: Annotated[str, Field(examples=['GET|60d83e70|e3b0c442|https://api.scrape.ly'])]
     """
     A unique key used for request de-duplication. Requests with the same unique key are considered identical.
     """
@@ -737,11 +737,6 @@ class CommonActorPricingInfo(BaseModel):
         populate_by_name=True,
         alias_generator=to_camel,
     )
-    apify_margin_percentage: float | None = None
-    """
-    In [0, 1], fraction of pricePerUnitUsd that goes to Scrapely.
-    Optional: Scrapely staging PAY_PER_EVENT payloads often omit this.
-    """
     created_at: AwareDatetime | None = None
     """
     When this pricing info record has been created.
@@ -774,11 +769,11 @@ class CreateActorRequest(BaseModel):
         None
     )
     """
-    Short description of the Actor, displayed in Scrapely Store and Console.
+    Short description of the Actor, displayed in Scrapely Store and dashboard.
     """
     title: Annotated[str | None, Field(examples=['Instagram scraper'])] = None
     """
-    Human-readable name of the Actor, displayed in Scrapely Store and Console. Can contain spaces and capital letters. Recommended length is 40-50 characters. You can change this title without affecting the Actor's URL or SEO.
+    Human-readable name of the Actor, displayed in Scrapely Store and dashboard. Can contain spaces and capital letters. Recommended length is 40-50 characters. You can change this title without affecting the Actor's URL or SEO.
     """
     is_public: Annotated[bool | None, Field(examples=[False])] = None
     """
@@ -786,7 +781,7 @@ class CreateActorRequest(BaseModel):
     """
     seo_title: Annotated[str | None, Field(examples=['Free Instagram scraper'])] = None
     """
-    Name of the Actor to display by search engines such as Google. Can be different from the Actor's name displayed in Scrapely Store and Console. Recommended length is 40-50 characters.
+    Name of the Actor to display by search engines such as Google. Can be different from the Actor's name displayed in Scrapely Store and dashboard. Recommended length is 40-50 characters.
     """
     seo_description: Annotated[str | None, Field(examples=['The best scraper for Instagram'])] = None
     """
@@ -920,7 +915,6 @@ class CurrentPricingInfo(BaseModel):
         alias_generator=to_camel,
     )
     pricing_model: Annotated[str, Field(examples=['FREE'])]
-    apify_margin_percentage: Annotated[float | None, Field(examples=[0.2])] = None
     created_at: Annotated[AwareDatetime | None, Field(examples=['2023-01-01T00:00:00.000Z'])] = None
     started_at: Annotated[AwareDatetime | None, Field(examples=['2023-01-01T00:00:00.000Z'])] = None
     notified_about_change_at: Annotated[AwareDatetime | None, Field(examples=[None])] = None
@@ -998,7 +992,7 @@ class Dataset(BaseModel):
     """
     console_url: Annotated[AnyUrl, Field(examples=['https://api.scrape.ly/storage/datasets/27TmTznX9YPeAYhkC'])]
     items_public_url: Annotated[
-        AnyUrl | None, Field(examples=['https://api-staging.scrape.ly/v2/datasets/WkzbQMuFYuamGv3YF/items?signature=abc123'])
+        AnyUrl | None, Field(examples=['https://api.scrape.ly/v2/datasets/WkzbQMuFYuamGv3YF/items?signature=abc123'])
     ] = None
     """
     A public link to access the dataset items directly.
@@ -1215,7 +1209,7 @@ class DeletedRequestById(BaseModel):
         populate_by_name=True,
         alias_generator=to_camel,
     )
-    unique_key: Annotated[str | None, Field(examples=['GET|60d83e70|e3b0c442|https://api-staging.scrape.ly'])] = None
+    unique_key: Annotated[str | None, Field(examples=['GET|60d83e70|e3b0c442|https://api.scrape.ly'])] = None
     """
     A unique key used for request de-duplication. Requests with the same unique key are considered identical.
     """
@@ -1234,7 +1228,7 @@ class DeletedRequestByUniqueKey(BaseModel):
         populate_by_name=True,
         alias_generator=to_camel,
     )
-    unique_key: Annotated[str, Field(examples=['GET|60d83e70|e3b0c442|https://api-staging.scrape.ly'])]
+    unique_key: Annotated[str, Field(examples=['GET|60d83e70|e3b0c442|https://api.scrape.ly'])]
     """
     A unique key used for request de-duplication. Requests with the same unique key are considered identical.
     """
@@ -1472,11 +1466,11 @@ class HeadRequest(BaseModel):
     """
     A unique identifier assigned to the request.
     """
-    unique_key: Annotated[str, Field(examples=['GET|60d83e70|e3b0c442|https://api-staging.scrape.ly'])]
+    unique_key: Annotated[str, Field(examples=['GET|60d83e70|e3b0c442|https://api.scrape.ly'])]
     """
     A unique key used for request de-duplication. Requests with the same unique key are considered identical.
     """
-    url: Annotated[str, Field(examples=['https://api-staging.scrape.ly'])]
+    url: Annotated[str, Field(examples=['https://api.scrape.ly'])]
     """
     The URL of the request.
     """
@@ -1537,13 +1531,13 @@ class KeyValueStore(BaseModel):
     ] = None
     keys_public_url: Annotated[
         AnyUrl | None,
-        Field(examples=['https://api-staging.scrape.ly/v2/key-value-stores/WkzbQMuFYuamGv3YF/keys?signature=abc123']),
+        Field(examples=['https://api.scrape.ly/v2/key-value-stores/WkzbQMuFYuamGv3YF/keys?signature=abc123']),
     ] = None
     """
     A public link to access keys of the key-value store directly.
     """
     records_public_url: Annotated[
-        AnyUrl | None, Field(examples=['https://api-staging.scrape.ly/v2/key-value-stores/WkzbQMuFYuamGv3YF/records'])
+        AnyUrl | None, Field(examples=['https://api.scrape.ly/v2/key-value-stores/WkzbQMuFYuamGv3YF/records'])
     ] = None
     """
     A public link to access records of the key-value store directly.
@@ -1572,7 +1566,7 @@ class KeyValueStoreKey(BaseModel):
     record_public_url: Annotated[
         AnyUrl,
         Field(
-            examples=['https://api-staging.scrape.ly/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key?signature=abc123']
+            examples=['https://api.scrape.ly/v2/key-value-stores/WkzbQMuFYuamGv3YF/records/some-key?signature=abc123']
         ),
     ]
     """
@@ -1891,11 +1885,11 @@ class LockedHeadRequest(BaseModel):
     """
     A unique identifier assigned to the request.
     """
-    unique_key: Annotated[str, Field(examples=['GET|60d83e70|e3b0c442|https://api-staging.scrape.ly'])]
+    unique_key: Annotated[str, Field(examples=['GET|60d83e70|e3b0c442|https://api.scrape.ly'])]
     """
     A unique key used for request de-duplication. Requests with the same unique key are considered identical.
     """
-    url: Annotated[str, Field(examples=['https://api-staging.scrape.ly'])]
+    url: Annotated[str, Field(examples=['https://api.scrape.ly'])]
     """
     The URL of the request.
     """
@@ -2212,7 +2206,7 @@ class Plan(BaseModel):
     max_monthly_external_data_transfer_gbytes: Annotated[float | None, Field(examples=[1000])] = None
     max_actor_count: Annotated[int | None, Field(examples=[100])] = None
     max_actor_task_count: Annotated[int | None, Field(examples=[1000])] = None
-    data_retention_days: Annotated[int | None, Field(examples=[14])] = None
+    data_retention_days: Annotated[int | None, Field(examples=[90])] = None
     available_proxy_groups: dict[str, int]
     team_account_seat_count: Annotated[int | None, Field(examples=[1])] = None
     support_level: Annotated[str | None, Field(examples=['COMMUNITY'])] = None
@@ -2291,7 +2285,7 @@ class Profile(BaseModel):
     )
     bio: Annotated[str | None, Field(examples=['I started web scraping in 1985 using Altair BASIC.'])] = None
     name: Annotated[str | None, Field(examples=['Jane Doe'])] = None
-    picture_url: Annotated[AnyUrl | None, Field(examples=['https://api-staging.scrape.ly/img/anonymous_user_picture.png'])] = None
+    picture_url: Annotated[AnyUrl | None, Field(examples=['https://api.scrape.ly/img/anonymous_user_picture.png'])] = None
     github_username: Annotated[str | None, Field(examples=['torvalds.'])] = None
     website_url: Annotated[AnyUrl | None, Field(examples=['http://www.example.com'])] = None
     twitter_username: Annotated[str | None, Field(examples=['@BillGates'])] = None
@@ -2435,11 +2429,11 @@ class RequestBase(BaseModel):
         populate_by_name=True,
         alias_generator=to_camel,
     )
-    unique_key: Annotated[str | None, Field(examples=['GET|60d83e70|e3b0c442|https://api-staging.scrape.ly'])] = None
+    unique_key: Annotated[str | None, Field(examples=['GET|60d83e70|e3b0c442|https://api.scrape.ly'])] = None
     """
     A unique key used for request de-duplication. Requests with the same unique key are considered identical.
     """
-    url: Annotated[str | None, Field(examples=['https://api-staging.scrape.ly'])] = None
+    url: Annotated[str | None, Field(examples=['https://api.scrape.ly'])] = None
     """
     The URL of the request.
     """
@@ -2448,7 +2442,7 @@ class RequestBase(BaseModel):
     """
     The number of times this request has been retried.
     """
-    loaded_url: Annotated[str | None, Field(examples=['https://api-staging.scrape.ly/jobs'])] = None
+    loaded_url: Annotated[str | None, Field(examples=['https://api.scrape.ly/jobs'])] = None
     """
     The final URL that was loaded, after redirects (if any).
     """
@@ -2503,11 +2497,11 @@ class RequestDraft(BaseModel):
     """
     A unique identifier assigned to the request.
     """
-    unique_key: Annotated[str, Field(examples=['GET|60d83e70|e3b0c442|https://api-staging.scrape.ly'])]
+    unique_key: Annotated[str, Field(examples=['GET|60d83e70|e3b0c442|https://api.scrape.ly'])]
     """
     A unique key used for request de-duplication. Requests with the same unique key are considered identical.
     """
-    url: Annotated[str, Field(examples=['https://api-staging.scrape.ly'])]
+    url: Annotated[str, Field(examples=['https://api.scrape.ly'])]
     """
     The URL of the request.
     """
@@ -2527,7 +2521,7 @@ class RequestDraftDeleteById(BaseModel):
     """
     A unique identifier assigned to the request.
     """
-    unique_key: Annotated[str | None, Field(examples=['GET|60d83e70|e3b0c442|https://api-staging.scrape.ly'])] = None
+    unique_key: Annotated[str | None, Field(examples=['GET|60d83e70|e3b0c442|https://api.scrape.ly'])] = None
     """
     A unique key used for request de-duplication. Requests with the same unique key are considered identical.
     """
@@ -2546,7 +2540,7 @@ class RequestDraftDeleteByUniqueKey(BaseModel):
     """
     A unique identifier assigned to the request.
     """
-    unique_key: Annotated[str, Field(examples=['GET|60d83e70|e3b0c442|https://api-staging.scrape.ly'])]
+    unique_key: Annotated[str, Field(examples=['GET|60d83e70|e3b0c442|https://api.scrape.ly'])]
     """
     A unique key used for request de-duplication. Requests with the same unique key are considered identical.
     """
@@ -2632,9 +2626,9 @@ class RequestQueue(BaseModel):
     """
     Whether the request queue has been accessed by multiple different clients.
     """
-    console_url: Annotated[AnyUrl, Field(examples=['https://api-staging.scrape.ly/v2/request-queues/27TmTznX9YPeAYhkC'])]
+    console_url: Annotated[AnyUrl, Field(examples=['https://api.scrape.ly/v2/request-queues/27TmTznX9YPeAYhkC'])]
     """
-    The URL to view the request queue in the Scrapely console.
+    The URL to view the request queue in the Scrapely dashboard.
     """
     stats: RequestQueueStats | None = None
     general_access: GeneralAccess | None = None
@@ -2952,7 +2946,7 @@ class Run(BaseModel):
     """
     Build number of the Actor build used for this run.
     """
-    container_url: Annotated[AnyUrl | None, Field(examples=['https://g8kd8kbc5ge8.runs.apify.net'])] = None
+    container_url: Annotated[AnyUrl | None, Field(examples=['https://g8kd8kbc5ge8.runs.scrape.ly'])] = None
     """
     URL of the container running the Actor.
     """
@@ -3669,7 +3663,7 @@ class UpdateActorRequest(BaseModel):
         None
     )
     """
-    Short description of the Actor, displayed in Scrapely Store and Console.
+    Short description of the Actor, displayed in Scrapely Store and dashboard.
     """
     is_public: Annotated[bool | None, Field(examples=[False])] = None
     """
@@ -3678,7 +3672,7 @@ class UpdateActorRequest(BaseModel):
     actor_permission_level: ActorPermissionLevel | None = None
     seo_title: Annotated[str | None, Field(examples=['Free Instagram scraper'])] = None
     """
-    Name of the Actor to display by search engines such as Google. Can be different from the Actor's name displayed in Scrapely Store and Console. Recommended length is 40-50 characters.
+    Name of the Actor to display by search engines such as Google. Can be different from the Actor's name displayed in Scrapely Store and dashboard. Recommended length is 40-50 characters.
     """
     seo_description: Annotated[str | None, Field(examples=['The best scraper for Instagram'])] = None
     """
@@ -3686,7 +3680,7 @@ class UpdateActorRequest(BaseModel):
     """
     title: Annotated[str | None, Field(examples=['Instagram scraper'])] = None
     """
-    Human-readable name of the Actor, displayed in Scrapely Store and Console. Can contain spaces and capital letters. Recommended length is 40-50 characters. You can change this title without affecting the Actor's URL or SEO.
+    Human-readable name of the Actor, displayed in Scrapely Store and dashboard. Can contain spaces and capital letters. Recommended length is 40-50 characters. You can change this title without affecting the Actor's URL or SEO.
     """
     restart_on_error: Annotated[bool | None, Field(deprecated=True, examples=[False])] = None
     versions: list[CreateOrUpdateVersionRequest] | None = None
@@ -3758,7 +3752,7 @@ class UpdateLimitsRequest(BaseModel):
     """
     data_retention_days: Annotated[int | None, Field(examples=[90])] = None
     """
-    Scrapely securely stores your ten most recent Actor runs indefinitely, ensuring they are always accessible. Unnamed storages and other Actor runs are automatically deleted after the retention period. If you're subscribed, you can change it to keep data for longer or to limit your usage. Lear more.
+    How many days unnamed storages (datasets, key-value stores and request queues without a name) are kept: Free 2 days (48 hours), Starter 31, Scale 60, Business 90. Runs follow their own retention: on the Free plan the latest 10 runs per Actor are kept and older ones are deleted after 7 days; on paid plans runs are deleted after 31 days. This value is set by your plan and cannot be changed through the API.
 
     """
 

scrapely_client/_resource_clients/__init__.py

@@ -4,6 +4,8 @@ from .actor_env_var import ActorEnvVarClient, ActorEnvVarClientAsync
 from .actor_env_var_collection import ActorEnvVarCollectionClient, ActorEnvVarCollectionClientAsync
 from .actor_version import ActorVersionClient, ActorVersionClientAsync
 from .actor_version_collection import ActorVersionCollectionClient, ActorVersionCollectionClientAsync
+from .automation import AutomationClient, AutomationClientAsync
+from .automation_collection import AutomationCollectionClient, AutomationCollectionClientAsync
 from .build import BuildClient, BuildClientAsync
 from .build_collection import BuildCollectionClient, BuildCollectionClientAsync
 from .dataset import DatasetClient, DatasetClientAsync
@@ -39,6 +41,10 @@ __all__ = [
     'ActorVersionClientAsync',
     'ActorVersionCollectionClient',
     'ActorVersionCollectionClientAsync',
+    'AutomationClient',
+    'AutomationClientAsync',
+    'AutomationCollectionClient',
+    'AutomationCollectionClientAsync',
     'BuildClient',
     'BuildClientAsync',
     'BuildCollectionClient',

scrapely_client/_resource_clients/_resource_client.py

@@ -328,7 +328,7 @@ class ResourceClient(ResourceClientBase):
             DEFAULT_WAIT_WHEN_JOB_NOT_EXIST seconds.
 
         Raises:
-            ApifyApiError: If API returns errors other than 404.
+            ScrapelyApiError: If API returns errors other than 404.
         """
         deadline = (datetime.now(UTC) + wait_duration) if wait_duration is not None else None
         not_found_deadline: datetime | None = None
@@ -520,7 +520,7 @@ class ResourceClientAsync(ResourceClientBase):
             DEFAULT_WAIT_WHEN_JOB_NOT_EXIST seconds.
 
         Raises:
-            ApifyApiError: If API returns errors other than 404.
+            ScrapelyApiError: If API returns errors other than 404.
         """
         deadline = (datetime.now(UTC) + wait_duration) if wait_duration is not None else None
         not_found_deadline: datetime | None = None

scrapely_client/_resource_clients/actor.py

@@ -67,7 +67,7 @@ class ActorClient(ResourceClient):
     """Sub-client for managing a specific Actor.
 
     Provides methods to manage a specific Actor, e.g. update it, delete it, build it, or start runs. Obtain an instance
-    via an appropriate method on the `ApifyClient` class.
+    via an appropriate method on the `ScrapelyClient` class.
     """
 
     def __init__(
@@ -563,7 +563,7 @@ class ActorClientAsync(ResourceClientAsync):
     """Sub-client for managing a specific Actor.
 
     Provides methods to manage a specific Actor, e.g. update it, delete it, build it, or start runs. Obtain an instance
-    via an appropriate method on the `ApifyClientAsync` class.
+    via an appropriate method on the `ScrapelyClientAsync` class.
     """
 
     def __init__(

scrapely_client/_resource_clients/actor_collection.py

@@ -32,7 +32,7 @@ class ActorCollectionClient(ResourceClient):
     """Sub-client for the Actor collection.
 
     Provides methods to manage the Actor collection, e.g. list or create Actors. Obtain an instance via an appropriate
-    method on the `ApifyClient` class.
+    method on the `ScrapelyClient` class.
     """
 
     def __init__(
@@ -208,7 +208,7 @@ class ActorCollectionClientAsync(ResourceClientAsync):
     """Sub-client for the Actor collection.
 
     Provides methods to manage the Actor collection, e.g. list or create Actors. Obtain an instance via an appropriate
-    method on the `ApifyClientAsync` class.
+    method on the `ScrapelyClientAsync` class.
     """
 
     def __init__(