mark v3 as deprecated

Author: maxkahan

CHANGES.md

@@ -1,3 +1,6 @@
+# 3.18.0
+- Mark v3 as deprecated
+
 # 3.17.4
 - Drop support for Python 3.8, add support for 3.13
 

README.md

@@ -7,6 +7,25 @@
 [![Python versions supported](https://img.shields.io/pypi/pyversions/vonage.svg)](https://pypi.python.org/pypi/vonage)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
 
+
+-----
+
+# DEPRECATED
+
+⚠️ **NOTE: This version of the Vonage Python SDK is now deprecated. It is strongly recommended to use the current major version of the SDK instead.** ⚠️
+
+Please upgrade to version 4 or later:
+
+```bash
+pip install "vonage>=4.0.0"
+```
+
+### Migration Guide
+
+To help you to move away from using v3, [you can find a migration guide here](https://github.com/Vonage/vonage-python-sdk/blob/main/V3_TO_V4_SDK_MIGRATION_GUIDE.md).
+
+-------
+
 This is the Python server SDK for Vonage's API. To use it you'll
 need a Vonage account. Sign up [for free at vonage.com][signup].
 

setup.py

@@ -10,7 +10,7 @@
 setup(
     name="vonage",
     version="3.17.4",
-    description="Vonage Server SDK for Python",
+    description="Vonage Server SDK for Python (Deprecated - use vonage>=4.0.0)",
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/Vonage/vonage-python-sdk",

src/vonage/__init__.py

@@ -2,3 +2,11 @@
 from .ncco_builder.ncco import *
 
 __version__ = "3.17.4"
+
+from warnings import warn
+
+warn(
+    'v3 of the Vonage Python SDK is now deprecated. Please upgrade to vonage>=4.0.0.',
+    DeprecationWarning,
+    stacklevel=2,
+)