You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: python/docs/index.md
+21-22Lines changed: 21 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,33 +13,15 @@ To install the Sift Python library:
13
13
pip install sift-stack-py
14
14
```
15
15
16
-
## API Documentation
16
+
This library follows [semantic versioning](https://semver.org/) and is under active development.
17
17
18
-
This documentation covers two Python APIs for interacting with Sift:
19
-
20
-
### Sift Py API
21
-
22
-
The original low-level Python API that provides direct access to Sift's protocol buffer interfaces.
23
-
24
-
Browse the [**Sift Py API**][sift_py] section for complete reference documentation.
25
-
26
-
**Use this API if you need:**
27
-
28
-
- Direct protocol buffer access
29
-
- Fine-grained control over gRPC connections
30
-
- Legacy compatibility with existing code
31
-
32
-
### Sift Client API (New)
33
-
34
-
!!! warning
35
-
The Sift Client is experimental and is subject to change.
36
-
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`).
18
+
**Pin to a major version** (e.g., `sift-stack-py~=1.0`) to avoid breaking changes between major releases.
38
19
20
+
## Sift Client API
39
21
40
22
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.
41
23
42
-
Explore the [**Sift Client API (New)**][sift_client] section for the complete API reference.
24
+
Explore the [**Sift Client API**][sift_client] section for the complete API reference.
43
25
44
26
**Key improvements over Sift Py:**
45
27
@@ -50,6 +32,23 @@ Explore the [**Sift Client API (New)**][sift_client] section for the complete AP
50
32
-**Rich Object Models** - Immutable types with convenient methods
51
33
-**Modern Patterns** - Context managers, iterators, and Python best practices
52
34
35
+
### Sift Py API
36
+
37
+
!!! warning "Deprecation Warning"
38
+
39
+
The `sift_py` module is deprecated as of **v0.10.0**. Please use `sift_client` if you aren't already.
40
+
The `sift_py` module will be removed entirely in **v1.0.0**.
41
+
42
+
The original low-level Python API that provides direct access to Sift's protocol buffer interfaces.
43
+
44
+
Browse the [**Sift Py API**][sift_py] section for complete reference documentation.
Copy file name to clipboardExpand all lines: python/lib/sift_client/__init__.py
-6Lines changed: 0 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,5 @@
1
1
"""Sift Client Library - Python client for interacting with Sift APIs.
2
2
3
-
!!! warning
4
-
The Sift Client is experimental and is subject to change.
5
-
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
-
9
3
## Overview
10
4
11
5
This library provides a high-level Python client for interacting with Sift APIs. It offers:
It provides both synchronous and asynchronous interfaces, strong type checking, and a Pythonic API design.
50
47
51
-
!!! warning
52
-
The Sift Client is experimental and is subject to change.
53
-
54
-
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`).
0 commit comments