refactor!: Enforce keyword-only arguments across all APIs

docs/01_overview/code/01_usage_async.py

@@ -5,17 +5,17 @@
 
 
 async def main() -> None:
-    apify_client = ApifyClientAsync(TOKEN)
+    apify_client = ApifyClientAsync(token=TOKEN)
 
     # Start an Actor and wait for it to finish.
-    actor_client = apify_client.actor('john-doe/my-cool-actor')
+    actor_client = apify_client.actor(actor_id='john-doe/my-cool-actor')
     call_result = await actor_client.call()
 
     if call_result is None:
         print('Actor run failed.')
         return
 
     # Fetch results from the Actor run's default dataset.
-    dataset_client = apify_client.dataset(call_result.default_dataset_id)
+    dataset_client = apify_client.dataset(dataset_id=call_result.default_dataset_id)
     list_items_result = await dataset_client.list_items()
     print(f'Dataset: {list_items_result}')

docs/01_overview/code/01_usage_sync.py

@@ -5,17 +5,17 @@
 
 
 def main() -> None:
-    apify_client = ApifyClient(TOKEN)
+    apify_client = ApifyClient(token=TOKEN)
 
     # Start an Actor and wait for it to finish.
-    actor_client = apify_client.actor('john-doe/my-cool-actor')
+    actor_client = apify_client.actor(actor_id='john-doe/my-cool-actor')
     call_result = actor_client.call()
 
     if call_result is None:
         print('Actor run failed.')
         return
 
     # Fetch results from the Actor run's default dataset.
-    dataset_client = apify_client.dataset(call_result.default_dataset_id)
+    dataset_client = apify_client.dataset(dataset_id=call_result.default_dataset_id)
     list_items_result = dataset_client.list_items()
     print(f'Dataset: {list_items_result}')

docs/01_overview/code/02_auth_async.py

@@ -5,4 +5,4 @@
 
 async def main() -> None:
     # Client initialization with the API token.
-    apify_client = ApifyClientAsync(TOKEN)
+    apify_client = ApifyClientAsync(token=TOKEN)

docs/01_overview/code/02_auth_sync.py

@@ -5,4 +5,4 @@
 
 def main() -> None:
     # Client initialization with the API token.
-    apify_client = ApifyClient(TOKEN)
+    apify_client = ApifyClient(token=TOKEN)

docs/01_overview/code/03_dataset_async.py

@@ -4,8 +4,8 @@
 
 
 async def main() -> None:
-    apify_client = ApifyClientAsync(TOKEN)
-    dataset_client = apify_client.dataset('dataset-id')
+    apify_client = ApifyClientAsync(token=TOKEN)
+    dataset_client = apify_client.dataset(dataset_id='dataset-id')
 
     # Lists items from the Actor's dataset.
     dataset_items = (await dataset_client.list_items()).items

docs/01_overview/code/03_dataset_sync.py

@@ -4,8 +4,8 @@
 
 
 def main() -> None:
-    apify_client = ApifyClient(TOKEN)
-    dataset_client = apify_client.dataset('dataset-id')
+    apify_client = ApifyClient(token=TOKEN)
+    dataset_client = apify_client.dataset(dataset_id='dataset-id')
 
     # Lists items from the Actor's dataset.
     dataset_items = dataset_client.list_items().items

docs/01_overview/code/03_input_async.py

@@ -4,8 +4,8 @@
 
 
 async def main() -> None:
-    apify_client = ApifyClientAsync(TOKEN)
-    actor_client = apify_client.actor('username/actor-name')
+    apify_client = ApifyClientAsync(token=TOKEN)
+    actor_client = apify_client.actor(actor_id='username/actor-name')
 
     # Define the input for the Actor.
     run_input = {

docs/01_overview/code/03_input_sync.py

@@ -4,8 +4,8 @@
 
 
 def main() -> None:
-    apify_client = ApifyClient(TOKEN)
-    actor_client = apify_client.actor('username/actor-name')
+    apify_client = ApifyClient(token=TOKEN)
+    actor_client = apify_client.actor(actor_id='username/actor-name')
 
     # Define the input for the Actor.
     run_input = {

docs/02_concepts/code/01_async_support.py

@@ -6,12 +6,12 @@
 
 
 async def main() -> None:
-    apify_client = ApifyClientAsync(TOKEN)
-    actor_client = apify_client.actor('my-actor-id')
+    apify_client = ApifyClientAsync(token=TOKEN)
+    actor_client = apify_client.actor(actor_id='my-actor-id')
 
     # Start the Actor and get the run ID
     run_result = await actor_client.start()
-    run_client = apify_client.run(run_result.id)
+    run_client = apify_client.run(run_id=run_result.id)
     log_client = run_client.log()
 
     # Stream the logs

docs/02_concepts/code/02_collection_async.py

@@ -4,7 +4,7 @@
 
 
 async def main() -> None:
-    apify_client = ApifyClientAsync(TOKEN)
+    apify_client = ApifyClientAsync(token=TOKEN)
 
     # Collection clients do not require a parameter
     actor_collection_client = apify_client.actors()

docs/02_concepts/code/02_collection_sync.py

@@ -4,7 +4,7 @@
 
 
 def main() -> None:
-    apify_client = ApifyClient(TOKEN)
+    apify_client = ApifyClient(token=TOKEN)
 
     # Collection clients do not require a parameter
     actor_collection_client = apify_client.actors()

docs/02_concepts/code/02_single_async.py

@@ -4,10 +4,10 @@
 
 
 async def main() -> None:
-    apify_client = ApifyClientAsync(TOKEN)
+    apify_client = ApifyClientAsync(token=TOKEN)
 
     # Resource clients accept an ID of the resource
-    actor_client = apify_client.actor('username/actor-name')
+    actor_client = apify_client.actor(actor_id='username/actor-name')
 
     # Fetch the 'username/actor-name' object from the API
     my_actor = await actor_client.get()

docs/02_concepts/code/02_single_sync.py

@@ -4,10 +4,10 @@
 
 
 def main() -> None:
-    apify_client = ApifyClient(TOKEN)
+    apify_client = ApifyClient(token=TOKEN)
 
     # Resource clients accept an ID of the resource
-    actor_client = apify_client.actor('username/actor-name')
+    actor_client = apify_client.actor(actor_id='username/actor-name')
 
     # Fetch the 'username/actor-name' object from the API
     my_actor = actor_client.get()

docs/02_concepts/code/03_nested_async.py

@@ -4,9 +4,9 @@
 
 
 async def main() -> None:
-    apify_client = ApifyClientAsync(TOKEN)
+    apify_client = ApifyClientAsync(token=TOKEN)
 
-    actor_client = apify_client.actor('username/actor-name')
+    actor_client = apify_client.actor(actor_id='username/actor-name')
     runs_client = actor_client.runs()
 
     # List the last 10 runs of the Actor

docs/02_concepts/code/03_nested_sync.py

@@ -4,9 +4,9 @@
 
 
 def main() -> None:
-    apify_client = ApifyClient(TOKEN)
+    apify_client = ApifyClient(token=TOKEN)
 
-    actor_client = apify_client.actor('username/actor-name')
+    actor_client = apify_client.actor(actor_id='username/actor-name')
     runs_client = actor_client.runs()
 
     # List the last 10 runs of the Actor

docs/02_concepts/code/04_error_async.py

@@ -4,11 +4,11 @@
 
 
 async def main() -> None:
-    apify_client = ApifyClientAsync(TOKEN)
+    apify_client = ApifyClientAsync(token=TOKEN)
 
     try:
         # Try to list items from non-existing dataset
-        dataset_client = apify_client.dataset('not-existing-dataset-id')
+        dataset_client = apify_client.dataset(dataset_id='not-existing-dataset-id')
         dataset_items = (await dataset_client.list_items()).items
     except Exception as ApifyApiError:
         # The exception is an instance of ApifyApiError

docs/02_concepts/code/04_error_sync.py

@@ -4,11 +4,11 @@
 
 
 def main() -> None:
-    apify_client = ApifyClient(TOKEN)
+    apify_client = ApifyClient(token=TOKEN)
 
     try:
         # Try to list items from non-existing dataset
-        dataset_client = apify_client.dataset('not-existing-dataset-id')
+        dataset_client = apify_client.dataset(dataset_id='not-existing-dataset-id')
         dataset_items = dataset_client.list_items().items
     except Exception as ApifyApiError:
         # The exception is an instance of ApifyApiError

docs/02_concepts/code/07_call_async.py

@@ -4,8 +4,8 @@
 
 
 async def main() -> None:
-    apify_client = ApifyClientAsync(TOKEN)
-    actor_client = apify_client.actor('username/actor-name')
+    apify_client = ApifyClientAsync(token=TOKEN)
+    actor_client = apify_client.actor(actor_id='username/actor-name')
 
     # Start an Actor and waits for it to finish
     finished_actor_run = await actor_client.call()

docs/02_concepts/code/07_call_sync.py

@@ -4,8 +4,8 @@
 
 
 def main() -> None:
-    apify_client = ApifyClient(TOKEN)
-    actor_client = apify_client.actor('username/actor-name')
+    apify_client = ApifyClient(token=TOKEN)
+    actor_client = apify_client.actor(actor_id='username/actor-name')
 
     # Start an Actor and waits for it to finish
     finished_actor_run = actor_client.call()

docs/02_concepts/code/08_pagination_async.py

@@ -4,10 +4,10 @@
 
 
 async def main() -> None:
-    apify_client = ApifyClientAsync(TOKEN)
+    apify_client = ApifyClientAsync(token=TOKEN)
 
     # Initialize the dataset client
-    dataset_client = apify_client.dataset('dataset-id')
+    dataset_client = apify_client.dataset(dataset_id='dataset-id')
 
     # Define the pagination parameters
     limit = 1000  # Number of items per page

docs/02_concepts/code/08_pagination_sync.py

@@ -4,10 +4,10 @@
 
 
 def main() -> None:
-    apify_client = ApifyClient(TOKEN)
+    apify_client = ApifyClient(token=TOKEN)
 
     # Initialize the dataset client
-    dataset_client = apify_client.dataset('dataset-id')
+    dataset_client = apify_client.dataset(dataset_id='dataset-id')
 
     # Define the pagination parameters
     limit = 1000  # Number of items per page

docs/02_concepts/code/09_streaming_async.py

@@ -4,8 +4,8 @@
 
 
 async def main() -> None:
-    apify_client = ApifyClientAsync(TOKEN)
-    run_client = apify_client.run('MY-RUN-ID')
+    apify_client = ApifyClientAsync(token=TOKEN)
+    run_client = apify_client.run(run_id='MY-RUN-ID')
     log_client = run_client.log()
 
     async with log_client.stream() as log_stream:

docs/02_concepts/code/09_streaming_sync.py

@@ -4,8 +4,8 @@
 
 
 def main() -> None:
-    apify_client = ApifyClient(TOKEN)
-    run_client = apify_client.run('MY-RUN-ID')
+    apify_client = ApifyClient(token=TOKEN)
+    run_client = apify_client.run(run_id='MY-RUN-ID')
     log_client = run_client.log()
 
     with log_client.stream() as log_stream:

docs/03_examples/code/01_input_async.py

@@ -11,7 +11,7 @@ async def main() -> None:
     apify_client = ApifyClientAsync(token=TOKEN)
 
     # Get the Actor client
-    actor_client = apify_client.actor('apify/instagram-hashtag-scraper')
+    actor_client = apify_client.actor(actor_id='apify/instagram-hashtag-scraper')
 
     input_data = {'hashtags': ['rainbow'], 'resultsLimit': 20}
 

docs/03_examples/code/01_input_sync.py

@@ -10,7 +10,7 @@ def main() -> None:
     apify_client = ApifyClient(token=TOKEN)
 
     # Get the Actor client
-    actor_client = apify_client.actor('apify/instagram-hashtag-scraper')
+    actor_client = apify_client.actor(actor_id='apify/instagram-hashtag-scraper')
 
     input_data = {'hashtags': ['rainbow'], 'resultsLimit': 20}
 

docs/03_examples/code/02_tasks_async.py

@@ -25,7 +25,7 @@ async def main() -> None:
     print('Tasks created:', apify_tasks)
 
     # Create Apify task clients
-    apify_task_clients = [apify_client.task(task.id) for task in apify_tasks]
+    apify_task_clients = [apify_client.task(task_id=task.id) for task in apify_tasks]
 
     print('Task clients created:', apify_task_clients)
 

docs/03_examples/code/02_tasks_sync.py

@@ -23,7 +23,7 @@ def main() -> None:
     print('Tasks created:', apify_tasks)
 
     # Create Apify task clients
-    apify_task_clients = [apify_client.task(task.id) for task in apify_tasks]
+    apify_task_clients = [apify_client.task(task_id=task.id) for task in apify_tasks]
 
     print('Task clients created:', apify_task_clients)
 

docs/03_examples/code/03_retrieve_async.py

@@ -8,7 +8,7 @@
 async def main() -> None:
     # Client initialization with the API token
     apify_client = ApifyClientAsync(token=TOKEN)
-    actor_client = apify_client.actor('apify/instagram-hashtag-scraper')
+    actor_client = apify_client.actor(actor_id='apify/instagram-hashtag-scraper')
     runs_client = actor_client.runs()
 
     # See pagination to understand how to get more datasets
@@ -19,12 +19,12 @@ async def main() -> None:
 
     for dataset_item in actor_datasets.items:
         # Dataset items can be handled here. Dataset items can be paginated
-        dataset_client = apify_client.dataset(dataset_item.id)
+        dataset_client = apify_client.dataset(dataset_id=dataset_item.id)
         dataset_items = await dataset_client.list_items(limit=1000)
 
         # Items can be pushed to single dataset
-        merging_dataset_client = apify_client.dataset(merging_dataset.id)
-        await merging_dataset_client.push_items(dataset_items.items)
+        merging_dataset_client = apify_client.dataset(dataset_id=merging_dataset.id)
+        await merging_dataset_client.push_items(items=dataset_items.items)
 
         # ...
 

docs/03_examples/code/03_retrieve_sync.py

@@ -6,7 +6,7 @@
 def main() -> None:
     # Client initialization with the API token
     apify_client = ApifyClient(token=TOKEN)
-    actor_client = apify_client.actor('apify/instagram-hashtag-scraper')
+    actor_client = apify_client.actor(actor_id='apify/instagram-hashtag-scraper')
     runs_client = actor_client.runs()
 
     # See pagination to understand how to get more datasets
@@ -17,12 +17,12 @@ def main() -> None:
 
     for dataset_item in actor_datasets.items:
         # Dataset items can be handled here. Dataset items can be paginated
-        dataset_client = apify_client.dataset(dataset_item.id)
+        dataset_client = apify_client.dataset(dataset_id=dataset_item.id)
         dataset_items = dataset_client.list_items(limit=1000)
 
         # Items can be pushed to single dataset
-        merging_dataset_client = apify_client.dataset(merging_dataset.id)
-        merging_dataset_client.push_items(dataset_items.items)
+        merging_dataset_client = apify_client.dataset(dataset_id=merging_dataset.id)
+        merging_dataset_client.push_items(items=dataset_items.items)
 
         # ...
 

docs/03_examples/code/04_pandas_async.py

@@ -10,7 +10,7 @@
 async def main() -> None:
     # Initialize the Apify client
     apify_client = ApifyClientAsync(token=TOKEN)
-    actor_client = apify_client.actor('apify/web-scraper')
+    actor_client = apify_client.actor(actor_id='apify/web-scraper')
     run_client = actor_client.last_run()
     dataset_client = run_client.dataset()
 

docs/03_examples/code/04_pandas_sync.py

@@ -8,7 +8,7 @@
 def main() -> None:
     # Initialize the Apify client
     apify_client = ApifyClient(token=TOKEN)
-    actor_client = apify_client.actor('apify/web-scraper')
+    actor_client = apify_client.actor(actor_id='apify/web-scraper')
     run_client = actor_client.last_run()
     dataset_client = run_client.dataset()