diff --git a/docs/changelog/overview.mdx b/docs/changelog/overview.mdx
index f613e4e..1c7bb58 100644
--- a/docs/changelog/overview.mdx
+++ b/docs/changelog/overview.mdx
@@ -12,6 +12,17 @@ This page lists changes to Flare's API.
Release notes for the Flare Platform can be found on the [product documentation website](https://docs.flare.io/releases).
+
+ Released version 2.0.0 of the
+ [Python SDK ](/sdk/python).
+
+ This release changes the API of `scroll_events` to yield `ScrollEventsResult` objects.
+ This new object exposes `metadata`, `event` and `next` fields.
+
+ The previous API for this method wouldn't expose the `metadata` and forced users of the library
+ to implement their own pagination logic.
+
+
Released the beta of the
[Flare API CLI ](/sdk/cli)
diff --git a/docs/sdk/python.mdx b/docs/sdk/python.mdx
index a1b76b3..d07a50b 100644
--- a/docs/sdk/python.mdx
+++ b/docs/sdk/python.mdx
@@ -120,7 +120,7 @@ from_timestamp: str = (
datetime.datetime.now(tz=datetime.timezone.utc) - datetime.timedelta(hours=1)
).isoformat()
-for event, next_cursor in api_client.scroll_events(
+for result in api_client.scroll_events(
method="POST",
pages_url="/firework/v4/events/global/_search",
events_url="/firework/v2/activities/",
@@ -138,8 +138,8 @@ for event, next_cursor in api_client.scroll_events(
},
},
):
- print(f"Full event data: {event}")
- print(f"The next execution could resume using from={next_cursor}")
+ print(f"Full event data: {result.event}")
+ print(f"The next execution could resume using from={result.next}")
```
## Custom Session
diff --git a/pyproject.toml b/pyproject.toml
index 8bec3ec..3a4344f 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -13,7 +13,7 @@ dependencies = [
"requests>=2.32",
"pytest>=8.4.2",
"types-requests>=2.32",
- "flareio>=1.2.0",
+ "flareio>=2.0.0",
]
[build-system]
diff --git a/uv.lock b/uv.lock
index 5c93387..4ba6fbb 100644
--- a/uv.lock
+++ b/uv.lock
@@ -56,14 +56,14 @@ wheels = [
[[package]]
name = "flareio"
-version = "1.2.5"
+version = "2.0.0"
source = { registry = "https://pypi.org/simple" }
dependencies = [
{ name = "requests" },
]
-sdist = { url = "https://files.pythonhosted.org/packages/7b/d2/0d3b0bd78bb368c92f22cde1181c4e22f171931b05672d8d98e86d7191f2/flareio-1.2.5.tar.gz", hash = "sha256:f03f6d18cb8605734aa5e99d43f23fb3d3f2e18cf53ae0bea1b1800798a71e1e", size = 4428, upload-time = "2026-02-07T07:26:09.308Z" }
+sdist = { url = "https://files.pythonhosted.org/packages/e6/1a/24bab51797e012acfdd1ba7dec698dd44c6f76d18599354086aa25f3bd46/flareio-2.0.0.tar.gz", hash = "sha256:ef18b00a294c273271499dbaa256abc1c25cec6ed1f087d04224bc4b17feebd1", size = 4478, upload-time = "2026-02-08T21:01:21.135Z" }
wheels = [
- { url = "https://files.pythonhosted.org/packages/68/7e/d93279892d2239e4ac2adfe621bf141ee4f23fb0900e418828464f372696/flareio-1.2.5-py3-none-any.whl", hash = "sha256:e00f79088a80fa46c02c81bade0aa2b874290dc307bfb9c837d910cffffc2faf", size = 5761, upload-time = "2026-02-07T07:26:07.997Z" },
+ { url = "https://files.pythonhosted.org/packages/64/93/c3ce1ee6a42aabf024872d5703cd0a8caa08613027289fa3ca1e4ef06266/flareio-2.0.0-py3-none-any.whl", hash = "sha256:48079372dbaa2f187ad1faaf50ad1a3930013754be17169c73027d626a91f67f", size = 5989, upload-time = "2026-02-08T21:01:20.369Z" },
]
[[package]]
@@ -101,7 +101,7 @@ dependencies = [
[package.metadata]
requires-dist = [
- { name = "flareio", specifier = ">=1.2.0" },
+ { name = "flareio", specifier = ">=2.0.0" },
{ name = "pydantic", specifier = ">=2.12.3" },
{ name = "pytest", specifier = ">=8.4.2" },
{ name = "python-frontmatter", specifier = ">=1.1.0" },