Merge pull request #103 from contentstack/feat/dx-3351

Implemented variants support

Author: sunil-lakshman

.talismanrc

@@ -369,3 +369,19 @@ fileignoreconfig:
 - filename: tests/unit/global_fields/test_global_fields_unittest.py
   checksum: 46297a6fbf321dfe4b85a3d2c1089614af8c9590d8352238c800ad69955b4b6a
 version: "1.0"
+fileignoreconfig:
+- filename: tests/unit/variant_group/test_variant_group.py
+  checksum: 7c3d5ee03ed59891c20f2447c9d6da423b28855455639f6a1f299a03c1ebe744
+- filename: tests/unit/entry_variants/test_entry_variants.py
+  checksum: 4f0d963c7e153974486af64e642dcfbf2d967448abe2344bcc3bddfb898384dc
+- filename: contentstack_management/variants/variants.py
+  checksum: c06b3471717db66b9e558c4c735a7690098839d87d96ef4b4be4c573b4a54709
+- filename: contentstack_management/entries/entry.py
+  checksum: 141933cd737709129bfe891cbbc5d19ed1435ac9611cc5fdf420087b98774ce9
+- filename: contentstack_management/entry_variants/entry_variants.py
+  checksum: a084c1b235d464def36854e662071c744b2f71abe33038ade439bbe313deea5d
+- filename: contentstack_management/variant_group/variant_group.py
+  checksum: a1d4824626aea510cd80c9b1920ede40cdc374ee9a81169811ca7980a9b67b32
+- filename: tests/unit/variants/test_variants.py
+  checksum: 866f8b27d41694d0b2a7273c842b2b2b25cab6dac5919edb7d4d658bc0aa20cb
+version: "1.0"

CHANGELOG.md

@@ -1,6 +1,13 @@
 # CHANGELOG
 
 ## Content Management SDK For Python
+---
+## v1.5.0
+
+#### Date:  25 August 2025
+
+- Variants feature support.
+
 ---
 ## v1.4.0
 

contentstack_management/__init__.py

@@ -16,6 +16,7 @@
 from .auditlogs.auditlog import Auditlog
 from .environments.environment import Environment
 from .entries.entry import Entry
+from .entry_variants.entry_variants import EntryVariants
 from .contentstack import Client, Region
 from ._api_client import _APIClient
 from .common import Parameter
@@ -31,6 +32,8 @@
 from .management_token.management_token import ManagementToken
 from .publish_queue.publish_queue import PublishQueue
 from .extensions.extension import Extension
+from .variant_group.variant_group import VariantGroup
+from .variants.variants import Variants
 
 
 __all__ = (
@@ -55,6 +58,7 @@
 "Auditlog",
 "Environment",
 "Entry",
+"EntryVariants",
 "Locale",
 "Taxonomy",
 "Label",
@@ -65,14 +69,16 @@
 "DeliveryToken",
 "ManagementToken",
 "PublishQueue",
-"Extension"
+"Extension",
+"VariantGroup",
+"Variants"
 )
 
 __title__ = 'contentstack-management-python'
 __author__ = 'dev-ex'
 __status__ = 'debug'
 __region__ = 'na'
-__version__ = '1.4.0'
+__version__ = '1.5.0'
 __host__ = 'api.contentstack.io'
 __protocol__ = 'https://'
 __api_version__ = 'v3'

contentstack_management/entries/entry.py

@@ -5,6 +5,7 @@
 
 import json
 from ..common import Parameter
+from ..entry_variants.entry_variants import EntryVariants
 
 class Entry(Parameter):
     """
@@ -421,13 +422,58 @@ def unpublish(self, data):
         data = json.dumps(data)
         return self.client.post(url, headers = self.client.headers, data = data, params = self.params)
 
-    
-    
-    
-    
+    def variants(self, variant_uid: str = None):
+        """
+        Returns an EntryVariants instance for managing variant entries.
+        
+        :param variant_uid: The `variant_uid` parameter is a string that represents the unique identifier of
+        the variant. It is used to specify which variant to work with
+        :type variant_uid: str
+        :return: EntryVariants instance for managing variant entries
+        -------------------------------
+        [Example:]
 
-    
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
+            >>> # Get all variant entries
+            >>> result = client.stack('api_key').content_types('content_type_uid').entry('entry_uid').variants().query().find().json()
+            >>> # Get specific variant entry
+            >>> result = client.stack('api_key').content_types('content_type_uid').entry('entry_uid').variants('variant_uid').fetch().json()
 
+        -------------------------------
+        """
+        
+        return EntryVariants(self.client, self.content_type_uid, self.entry_uid, variant_uid)
 
+    def includeVariants(self, include_variants: str = 'true', variant_uid: str = None, params: dict = None):
+        """
+        The includeVariants method retrieves the details of a specific base entry with variant details.
+        
+        :param include_variants: The `include_variants` parameter is a string that specifies whether to include variants
+        :type include_variants: str
+        :param variant_uid: The `variant_uid` parameter is a string that represents the unique identifier of
+        the variant. It is used to specify which variant to include
+        :type variant_uid: str
+        :param params: The `params` parameter is a dictionary that contains query parameters to be sent with the request
+        :type params: dict
+        :return: the result of the GET request made to the specified URL.
+        -------------------------------
+        [Example:]
 
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
+            >>> result = client.stack('api_key').content_types('content_type_uid').entry('entry_uid').includeVariants('true', 'variant_uid').json()
+            >>> # With parameters
+            >>> result = client.stack('api_key').content_types('content_type_uid').entry('entry_uid').includeVariants('true', 'variant_uid', params={'locale': 'en-us'}).json()
 
+        -------------------------------
+        """
+        if self.entry_uid is None:
+            raise Exception('Entry uid is required')
+        if params is not None:
+            self.params.update(params)
+        self.params['include_variants'] = include_variants
+        if variant_uid is not None and variant_uid != '':
+            self.params['variant_uid'] = variant_uid
+        url = f"content_types/{self.content_type_uid}/entries/{self.entry_uid}"
+        return self.client.get(url, headers = self.client.headers, params = self.params)

contentstack_management/entry_variants/__init__.py

@@ -0,0 +1,3 @@
+from .entry_variants import EntryVariants
+
+__all__ = ['EntryVariants']