Skip to content

Commit 8abb676

Browse files
Python(chore): add pinning recommendation (#415)
1 parent 26a9c3e commit 8abb676

3 files changed

Lines changed: 7 additions & 0 deletions

File tree

python/docs/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ Browse the [**Sift Py API**][sift_py] section for complete reference documentati
3434
!!! warning
3535
The Sift Client is experimental and is subject to change.
3636

37+
To avoid unexpected breaking changes, pin the exact version of the `sift-stack-py` library in your dependencies (for example, in `requirements.txt` or `pyproject.toml`).
38+
3739

3840
The modern, high-level client library that provides all the ergonomic features missing from the original API. This new client offers intuitive Python interfaces, strong type safety, automatic connection management, and both synchronous and asynchronous support.
3941

python/lib/sift_client/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
!!! warning
44
The Sift Client is experimental and is subject to change.
55
6+
To avoid unexpected breaking changes, pin the exact version of the `sift-stack-py` library in your dependencies (for example, in `requirements.txt` or `pyproject.toml`).
7+
8+
69
## Overview
710
811
This library provides a high-level Python client for interacting with Sift APIs. It offers:

python/lib/sift_client/client.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ class SiftClient(
4949
!!! warning
5050
The Sift Client is experimental and is subject to change.
5151
52+
To avoid unexpected breaking changes, pin the exact version of the `sift-stack-py` library in your dependencies (for example, in `requirements.txt` or `pyproject.toml`).
53+
5254
Examples:
5355
from sift_client import SiftClient
5456
from datetime import datetime

0 commit comments

Comments
 (0)