Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/changelog/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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).
</Note>

<Update label="2026-02-08" description="Python SDK - v2.0.0">
Released version 2.0.0 of the
[Python SDK <Icon icon="book" size={16} />](/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.
</Update>

<Update label="2026-02" description="CLI - February 2026">
Released the beta of the
[Flare API CLI <Icon icon="book" size={16} />](/sdk/cli)
Expand Down
6 changes: 3 additions & 3 deletions docs/sdk/python.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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/",
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
8 changes: 4 additions & 4 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.