Skip to content

Commit 8403f39

Browse files
committed
Merge remote-tracking branch 'origin/master' into docs/changelog-v3-cleanup
# Conflicts: # CHANGELOG.md
2 parents b088294 + e0a0bc8 commit 8403f39

55 files changed

Lines changed: 163236 additions & 29560 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CHANGELOG.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@
22

33
All notable changes to this project will be documented in this file.
44

5-
<!-- git-cliff-unreleased-start -->
6-
7-
## 3.0.0 - **not yet released**
5+
## [3.0.0](https://github.com/apify/apify-client-python/releases/tag/v3.0.0) (2026-05-20)
86

97
- Check out the [Upgrading guide](https://docs.apify.com/api/client/python/docs/upgrading/upgrading-to-v3) to ensure a smooth update.
108

@@ -42,8 +40,6 @@ All notable changes to this project will be documented in this file.
4240

4341
- [**breaking**] Drop support for Python 3.10 ([#636](https://github.com/apify/apify-client-python/pull/636)) ([7895a4e](https://github.com/apify/apify-client-python/commit/7895a4e60145f490911044da4aa7e3c1c424d416)) by [@vdusek](https://github.com/vdusek)
4442

45-
<!-- git-cliff-unreleased-end -->
46-
4743
## [2.5.1](https://github.com/apify/apify-client-python/releases/tag/v2.5.1) (2026-05-20)
4844

4945
### 🐛 Bug Fixes

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
44

55
[project]
66
name = "apify_client"
7-
version = "2.5.1"
7+
version = "3.0.0"
88
description = "Apify API client for Python"
99
authors = [{ name = "Apify Technologies s.r.o.", email = "support@apify.com" }]
1010
license = { file = "LICENSE" }

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

website/versioned_docs/version-2.5/01_introduction/code/03_input_async.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ async def main() -> None:
1212
'some': 'input',
1313
}
1414

15-
# Start an Actor and waits for it to finish.
15+
# Start an Actor and wait for it to finish.
1616
call_result = await actor_client.call(run_input=run_input)

website/versioned_docs/version-2.5/01_introduction/code/03_input_sync.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ def main() -> None:
1212
'some': 'input',
1313
}
1414

15-
# Start an Actor and waits for it to finish.
15+
# Start an Actor and wait for it to finish.
1616
call_result = actor_client.call(run_input=run_input)

website/versioned_docs/version-2.5/01_introduction/index.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
id: introduction
33
title: Overview
4-
sidebar_label: Overview
54
slug: /
6-
description: "The official Python library to access the Apify API, with automatic retries, async support, and comprehensive API coverage."
5+
description: The official Python library to access the Apify API, with automatic retries, async support, and comprehensive API coverage.
76
---
87

98
import Tabs from '@theme/Tabs';
@@ -24,7 +23,7 @@ The client simplifies interaction with the Apify platform by providing:
2423

2524
## Prerequisites
2625

27-
`apify-client` requires Python 3.10 or higher. Python is available for download on the [official website](https://www.python.org/downloads/). Check your current Python version by running:
26+
`apify-client` requires Python 3.11 or higher. Python is available for download on the [official website](https://www.python.org/downloads/). Check your current Python version by running:
2827

2928
```bash
3029
python --version
@@ -40,7 +39,7 @@ pip install apify-client
4039

4140
## Quick example
4241

43-
Here's an example showing how to run an Actor and retrieve its results:
42+
The following example shows how to run an Actor and retrieve its results:
4443

4544
<Tabs>
4645
<TabItem value="AsyncExample" label="Async client" default>

website/versioned_docs/version-2.5/01_introduction/quick-start.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
22
id: quick-start
33
title: Quick start
4-
sidebar_label: Quick start
5-
description: "Get started with the Apify API client for Python by running an Actor and retrieving results from its dataset."
4+
description: Get started with the Apify API client for Python by running an Actor and retrieving results from its dataset.
65
---
76

87
import Tabs from '@theme/Tabs';
Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
id: asyncio-support
33
title: Asyncio support
4+
description: Use the async client for non-blocking API calls with Python asyncio.
45
---
56

67
import Tabs from '@theme/Tabs';
@@ -10,10 +11,12 @@ import ApiLink from '@theme/ApiLink';
1011

1112
import AsyncSupportExample from '!!raw-loader!./code/01_async_support.py';
1213

13-
The package provides an asynchronous version of the client, <ApiLink to="class/ApifyClientAsync">`ApifyClientAsync`</ApiLink>, which allows you to interact with the Apify API using Python's standard async/await syntax. This enables you to perform non-blocking operations, see the Python [asyncio documentation](https://docs.python.org/3/library/asyncio-task.html) for more information.
14+
The package provides an asynchronous version of the client, <ApiLink to="class/ApifyClientAsync">`ApifyClientAsync`</ApiLink>, which allows you to interact with the Apify API using Python's standard async/await syntax. This enables you to perform non-blocking operations, see the Python [asyncio documentation](https://docs.python.org/3/library/asyncio-task.html) for more information. This is useful for applications that need to perform multiple API operations concurrently or integrate with other async frameworks.
1415

15-
The following example demonstrates how to run an Actor asynchronously and stream its logs while it is running:
16+
The following example shows how to run an Actor asynchronously and stream its logs while it is running:
1617

1718
<CodeBlock className="language-python">
1819
{AsyncSupportExample}
1920
</CodeBlock>
21+
22+
For the full async client API, see the <ApiLink to="class/ApifyClientAsync">`ApifyClientAsync`</ApiLink> reference.

website/versioned_docs/version-2.5/02_concepts/02_single_collection_clients.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
id: single-and-collection-clients
33
title: Single and collection clients
4+
description: Understand the two types of resource clients, single-resource and collection clients.
45
---
56

67
import Tabs from '@theme/Tabs';
@@ -14,7 +15,7 @@ import CollectionSyncExample from '!!raw-loader!./code/02_collection_sync.py';
1415
import SingleAsyncExample from '!!raw-loader!./code/02_single_async.py';
1516
import SingleSyncExample from '!!raw-loader!./code/02_single_sync.py';
1617

17-
The Apify client interface is designed to be consistent and intuitive across all of its components. When you call specific methods on the main client, you create specialized clients to manage individual API resources. There are two main types of clients:
18+
The Apify client provides two types of resource clients: single-resource clients for managing an individual resource, and collection clients for listing or creating resources.
1819

1920
- <ApiLink to="class/ActorClient">`ActorClient`</ApiLink> - Manages a single resource.
2021
- <ApiLink to="class/ActorCollectionClient">`ActorCollectionClient`</ApiLink> - Manages a collection of resources.

website/versioned_docs/version-2.5/02_concepts/03_nested_clients.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
id: nested-clients
33
title: Nested clients
4+
description: Access related resources directly through nested client methods.
45
---
56

67
import Tabs from '@theme/Tabs';
@@ -12,7 +13,7 @@ import ApiLink from '@theme/ApiLink';
1213
import NestedAsyncExample from '!!raw-loader!./code/03_nested_async.py';
1314
import NestedSyncExample from '!!raw-loader!./code/03_nested_sync.py';
1415

15-
In some cases, the Apify client provides nested clients to simplify working with related collections. For example, you can easily manage the runs of a specific Actor without having to construct multiple endpoints or client instances manually.
16+
Nested clients let you access related resources directly from a parent resource client, without manually constructing new client instances.
1617

1718
<Tabs>
1819
<TabItem value="AsyncExample" label="Async client" default>

0 commit comments

Comments
 (0)