Skip to content
This repository was archived by the owner on Aug 18, 2023. It is now read-only.

Commit

Permalink
Merge pull request #53 from klaviyo/20221025-jonb-deprecation
Browse files Browse the repository at this point in the history
20221025 jonb deprecation
  • Loading branch information
jon-batscha authored Oct 25, 2022
2 parents d21a045 + 6e1c9e4 commit 9fc84ca
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 45 deletions.
50 changes: 6 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,14 @@
# python-klaviyo - RETIRED
# python-klaviyo - DEPRECATED

## Deprecation Notice
# Deprecation Notice

This SDK and its associated [pip package](https://pypi.org/project/klaviyo/) is set to be deprecated on April 1st 2023 and will not receive further updates. To continue receiving API and SDK improvements, please follow the instructions below to migrate to the new [Klaviyo Python SDK](https://github.com/klaviyo/klaviyo-python-sdk).
This SDK and its associated pip package are set to be deprecated on April 1st 2023 and will not receive further updates.

## Migration Instructions
We recommend migrating over to our [newest SDK](https://github.com/klaviyo/klaviyo-api-python).

NOTE: this change is not backwards compatible; migrating to the new SDK requires completing the following steps:
You can read more about our SDK release history and support [here](https://developers.klaviyo.com/en/docs/sdk_overview)

### Install New SDK

`pip install klaviyo-sdk`

OR

`pip3 install klaviyo-sdk`

### Update Import

From:
```python
import klaviyo
```

To:
```python
import klaviyo_sdk
```

### Update Client Instantiation

From:
```python
client = klaviyo.Klaviyo(public_token=PUBLIC_TOKEN, private_token=PRIVATE_TOKEN)
```

To:
```python
client = klaviyo_sdk.Client(api_key=PRIVATE_TOKEN)
```

### Updating SDK Calls

The new SDK has many changes to the namespace (resource and function names), parameters (names, types, and format), and error handling. Please reference [this section](https://github.com/klaviyo/klaviyo-python-sdk#comprehensive-list-of-operations--parameters) of the new SDK repo for details on how to update each operation.

### Multistore limitation

The new SDK currently sets API keys at a global environment level. This means that if you manage multiple stores, each store's client must be running in a different environment. We plan to update this behavior to better support multistore applications.
For a comparison between our old and new APIs, check out [this guide](https://developers.klaviyo.com/en/docs/apis_comparison_chart).


# What is Klaviyo?
Expand Down
2 changes: 1 addition & 1 deletion klaviyo/__init__.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
__version__ = '3.1.5'
__version__ = '3.1.6'
from .api import Klaviyo

0 comments on commit 9fc84ca

Please # to comment.