contentstack-management 0.0.1__tar.gz → 1.0.1__tar.gz

{contentstack_management-0.0.1/contentstack_management.egg-info → contentstack-management-1.0.1}/PKG-INFO

@@ -1,20 +1,24 @@
 Metadata-Version: 2.1
 Name: contentstack-management
-Version: 0.0.1
+Version: 1.0.1
 Summary: Contentstack API Client Library for Python
 Home-page: https://github.com/contentstack/contentstack-management-python
-Author: Sunil
-Author-email: sunil <sunil.lakshman@contentstack.com>
+Author: ishaileshmishra
+Author-email: mobile@contentstack.com
 License: MIT
-Project-URL: Homepage, https://github.com/contentstack/contentstack-management-python
-Project-URL: Bug Tracker, https://github.com/contentstack/contentstack-management-python/issues
-Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.10
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
-Provides-Extra: dev
 License-File: LICENSE
+Requires-Dist: bson>=0.5.9
+Requires-Dist: requests>=2.5.4
+Requires-Dist: requests-toolbelt>=0.3.1
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: twine>=4.0.2; extra == "dev"
+Requires-Dist: dotenv>=0.0.5; extra == "dev"
 
 [![Contentstack](https://www.contentstack.com/docs/static/images/contentstack.png)](https://www.contentstack.com/)
 
@@ -39,9 +43,9 @@ pip install contentstack_management
 ```
 To import the SDK, use the following command:
 ```python
-from contentstack_management import contentstack
+import contentstack_management
 
-client = contentstack.ContentstackClient()
+client = contentstack_management.Client(authtoken='your_authtoken')
 ```
 
 ### Authentication
@@ -50,7 +54,7 @@ To use this SDK, you need to authenticate your users by using the Authtoken, cre
 
 An **Authtoken** is a read-write token used to make authorized CMA requests, and it is a **user-specific** token.
 ```python
-client = contentstack.ContentstackClient(authtoken= 'authtoken')
+client = contentstack_management.Client(authtoken= 'your_authtoken')
 ```
 ### Login
 To Login to Contentstack by using credentials, you can use the following lines of code:
@@ -72,9 +76,9 @@ print(result)
 To use the Python CMA SDK, you need to first initialize it. To do this, use the following code:
 
 ```python
-from contentstack_management import contentstack
+import contentstack_management
 
-client = contentstack.ContentstackClient(authtoken= 'authtoken')
+client = contentstack_management.Client(authtoken= 'your_authtoken')
 ```
 #### Fetch Stack Detail
 Use the following lines of code to fetch your stack detail using this SDK:

{contentstack_management-0.0.1 → contentstack-management-1.0.1}/README.md

@@ -21,9 +21,9 @@ pip install contentstack_management
 ```
 To import the SDK, use the following command:
 ```python
-from contentstack_management import contentstack
+import contentstack_management
 
-client = contentstack.ContentstackClient()
+client = contentstack_management.Client(authtoken='your_authtoken')
 ```
 
 ### Authentication
@@ -32,7 +32,7 @@ To use this SDK, you need to authenticate your users by using the Authtoken, cre
 
 An **Authtoken** is a read-write token used to make authorized CMA requests, and it is a **user-specific** token.
 ```python
-client = contentstack.ContentstackClient(authtoken= 'authtoken')
+client = contentstack_management.Client(authtoken= 'your_authtoken')
 ```
 ### Login
 To Login to Contentstack by using credentials, you can use the following lines of code:
@@ -54,9 +54,9 @@ print(result)
 To use the Python CMA SDK, you need to first initialize it. To do this, use the following code:
 
 ```python
-from contentstack_management import contentstack
+import contentstack_management
 
-client = contentstack.ContentstackClient(authtoken= 'authtoken')
+client = contentstack_management.Client(authtoken= 'your_authtoken')
 ```
 #### Fetch Stack Detail
 Use the following lines of code to fetch your stack detail using this SDK:

{contentstack_management-0.0.1 → contentstack-management-1.0.1}/contentstack_management/__init__.py

@@ -16,14 +16,26 @@ from .roles.roles import Roles
 from .auditlogs.auditlog import Auditlog
 from .environments.environment import Environment
 from .entries.entry import Entry
-from .contentstack import ContentstackClient, ContentstackRegion
+from .contentstack import Client, Region
 from ._api_client import _APIClient
 from .common import Parameter
 from ._errors import ArgumentException
+from .locale.locale import Locale
+from .taxonomies.taxonomy import Taxonomy
+from .labels.label import Label
+from .terms.terms import Terms
+from .bulk_operations.bulk_operation import BulkOperation
+from .releases.release import Releases
+from .release_items.release_item import ReleaseItems
+from .delivery_token.delivery_token import DeliveryToken
+from .management_token.management_token import ManagementToken
+from .publish_queue.publish_queue import PublishQueue
+from .extensions.extension import Extension
+
 
 __all__ = (
-"ContentstackClient",
-"ContentstackRegion",
+"Client",
+"Region",
 "_APIClient",
 "Parameter",
 "ArgumentException",
@@ -43,13 +55,24 @@ __all__ = (
 "Auditlog",
 "Environment",
 "Entry",
+"Locale",
+"Taxonomy",
+"Label",
+"Terms",
+"BulkOperation",
+"Releases",
+"ReleaseItems",
+"DeliveryToken",
+"ManagementToken",
+"PublishQueue",
+"Extension"
 )
 
 __title__ = 'contentstack-management-python'
 __author__ = 'ishaileshmishra'
 __status__ = 'debug'
 __region__ = 'na'
-__version__ = '0.0.1'
+__version__ = '1.0.1'
 __host__ = 'api.contentstack.io'
 __protocol__ = 'https://'
 __api_version__ = 'v3'

{contentstack_management-0.0.1 → contentstack-management-1.0.1}/contentstack_management/_api_client.py

@@ -130,7 +130,7 @@ class _APIClient:
         # headers = headers or {}
         return self._call_request('POST', url, headers=headers, params=params, data=data, json_data=json_data, files=files)
 
-    def delete(self, path, headers=None, params=None):
+    def delete(self, path, headers=None, params=None, data=None):
         """
         The function sends a DELETE request to a specified URL with optional headers and parameters.
         
@@ -150,4 +150,4 @@ class _APIClient:
         
         url = f"{self.endpoint}{path}"
         # headers = headers or {}
-        return self._call_request('DELETE', url, headers=headers, params=params)
+        return self._call_request('DELETE', url, headers=headers, params=params, data = data)

contentstack-management-1.0.1/contentstack_management/aliases/__init__.py

@@ -0,0 +1 @@
+import contentstack_management

{contentstack_management-0.0.1 → contentstack-management-1.0.1}/contentstack_management/aliases/aliases.py

@@ -25,9 +25,9 @@ class Alias(Parameter):
         :return: Returns all the aliases
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> branch = contentstack.ContentstackClient().stack(api_key='api_key').branch_alias()
-            >>> response = branch.find()
+            >>> import contentstack_management
+            >>> alias = contentstack_management.Client(authtoken='your_authtoken').stack(api_key='api_key').alias()
+            >>> response = alias.find()
         --------------------------------
         """
         return self.client.get(_path, headers=self.client.headers, params=self.params)
@@ -41,9 +41,9 @@ class Alias(Parameter):
         --------------------------------
 
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> branch = contentstack.ContentstackClient().stack(api_key='api_key').branch_alias('branch_alias_uid')
-            >>> response = branch.fetch()
+            >>> import contentstack_management
+            >>> alias = contentstack_management.Client(authtoken='your_authtoken').stack(api_key='api_key').alias('alias_uid')
+            >>> response = alias.fetch()
         --------------------------------
         """
         if self.alias_uid is None or '':
@@ -67,13 +67,13 @@ class Alias(Parameter):
             >>>            "target_branch": "test"
             >>>            }
             >>>        }
-            >>> branch = contentstack.ContentstackClient().stack(api_key='api_key').alias("alias_uid")
-            >>> response = branch.assign(data)
+            >>> alias = contentstack_management.Client(authtoken='your_authtoken').stack(api_key='api_key').alias("alias_uid")
+            >>> response = alias.assign(data)
         --------------------------------
         """
         url = f"{_path}/{self.alias_uid}"
         body = json.dumps(data)
-        return self.client.put(url, headers=self.client.headers, data=body)
+        return self.client.put(url, headers=self.client.headers, params=self.params, data=body)
 
     def delete(self):
         r"""
@@ -82,9 +82,9 @@ class Alias(Parameter):
         :return: Returns status code and message
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> branch = contentstack.ContentstackClient().stack(api_key='api_key').branch(branch_uid="branch_uid")
-            >>> response = branch.delete()
+            >>> import contentstack_management
+            >>> alias = contentstack_management.Client(authtoken='your_authtoken').stack(api_key='api_key').alias(alias_uid="alias_uid")
+            >>> response = alias.delete()
         --------------------------------
         """
         url = f"{_path}/{self.alias_uid}"

contentstack-management-1.0.1/contentstack_management/assets/__init__.py

@@ -0,0 +1 @@
+import contentstack_management

{contentstack_management-0.0.1 → contentstack-management-1.0.1}/contentstack_management/assets/assets.py

@@ -19,6 +19,7 @@ class Assets(Parameter):
         self.client = client
         self.asset_uid = asset_uid
         self.branch = branch
+        self.api_key = self.client.headers['api_key']
         super().__init__(self.client)
 
     def find(self):
@@ -31,9 +32,8 @@ class Assets(Parameter):
         is being returned.
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(host='host_name')
-            >>> client.login(email="email_id", password="password")
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> asset = client().stack(api_key='api_key').assets()
             >>> response = asset.find()
         --------------------------------
@@ -50,9 +50,8 @@ class Assets(Parameter):
         comprehensive information about a specific version of an asset of a stack.
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(host='host_name')
-            >>> client.login(email="email_id", password="password")
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> asset = client().stack(api_key='api_key').assets()
             >>> response = asset.fetch("asset_uid")
         --------------------------------
@@ -70,9 +69,8 @@ class Assets(Parameter):
         :return: The delete() method returns the status code and message as a response.
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(host='host_name')
-            >>> client.login(email="email_id", password="password")
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> asset = client().stack(api_key='api_key').assets()
             >>> response = asset.delete("asset_uid")
         --------------------------------
@@ -91,9 +89,8 @@ class Assets(Parameter):
         :return: the response from the API call made to retrieve all assets of a specific asset folder.
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(host='host_name')
-            >>> client.login(email="email_id", password="password")
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> asset = client().stack(api_key='api_key').assets()
             >>> response = asset.specific_folder("folder_uid")
         --------------------------------
@@ -114,9 +111,8 @@ class Assets(Parameter):
         within a specific parent asset folder.
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(host='host_name')
-            >>> client.login(email="email_id", password="password")
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> asset = client().stack(api_key='api_key').assets()
             >>> response = asset.subfolders("folder_uid")
         --------------------------------
@@ -137,9 +133,8 @@ class Assets(Parameter):
         file.
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(host='host_name')
-            >>> client.login(email="email_id", password="password")
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> file_path = ""
             >>> asset = client().stack(api_key='api_key').assets()
             >>> response = asset.upload(file_path)
@@ -161,9 +156,8 @@ class Assets(Parameter):
         provided headers, parameters, and files.
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(host='host_name')
-            >>> client.login(email="email_id", password="password")
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> file_path = ""
             >>> asset = client().stack(api_key='api_key').assets(asset_uid='asset_uid')
             >>> response = asset.replace(file_path)
@@ -187,9 +181,8 @@ class Assets(Parameter):
         the provided headers, parameters, and data.
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(host='host_name')
-            >>> client.login(email="email_id", password="password")
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> data = {
             >>>    "asset": {
             >>>        "permanent_url": "https://images.contentstack.io/v3/assets/stack_api_key/asset_UID/sample-slug.jpeg"
@@ -212,15 +205,14 @@ class Assets(Parameter):
         :return: The code is returning the result of the `get` request made to the specified URL.
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(host='host_name')
-            >>> client.login(email="email_id", password="password")
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> asset = client().stack(api_key='api_key').assets(asset_uid='asset_uid')
             >>> response = asset.download()
         --------------------------------
         """
         
-        url = f"assets/{api_key}/{self.asset_uid}"
+        url = f"assets/{self.api_key}/{self.asset_uid}"
         return self.client.get(url, headers = self.client.headers, params = self.params)
 
     def rte(self):
@@ -231,9 +223,8 @@ class Assets(Parameter):
         parameters.
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(host='host_name')
-            >>> client.login(email="email_id", password="password")
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> asset = client().stack(api_key='api_key').assets()
             >>> response = asset.rte()
         --------------------------------
@@ -253,9 +244,8 @@ class Assets(Parameter):
         :return: the result of the PUT request made to the specified URL.
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(host='host_name')
-            >>> client.login(email="email_id", password="password")
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> version_number = 1
             >>> data = {
 	        >>>     "upload": {
@@ -278,9 +268,8 @@ class Assets(Parameter):
         :return: The code is returning the result of the `client.get` method call.
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(host='host_name')
-            >>> client.login(email="email_id", password="password")
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> asset = client().stack(api_key='api_key').assets(asset_uid='asset_uid')
             >>> response = asset.version()
         --------------------------------
@@ -299,9 +288,8 @@ class Assets(Parameter):
         :return: the result of the delete request made to the specified URL.
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(host='host_name')
-            >>> client.login(email="email_id", password="password")
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> version_number = 1
             >>> asset = client().stack(api_key='api_key').assets(asset_uid='asset_uid')
             >>> response = asset.version_delete(version_number)
@@ -322,9 +310,8 @@ class Assets(Parameter):
         :return: the result of a GET request to a specific URL, with headers and parameters included.
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(host='host_name')
-            >>> client.login(email="email_id", password="password")
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> asset = client().stack(api_key='api_key').assets(asset_uid='asset_uid')
             >>> response = asset.references()
         --------------------------------
@@ -342,9 +329,8 @@ class Assets(Parameter):
         :return: the result of a GET request to a specific URL, with headers and parameters included.
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(host='host_name')
-            >>> client.login(email="email_id", password="password")
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> asset_type = "images"
             >>> asset = client().stack(api_key='api_key').assets()
             >>> response = asset.specific_asset_type(asset_type)
@@ -366,9 +352,8 @@ class Assets(Parameter):
         :return: the result of the `put` request made to the specified URL.
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(host='host_name')
-            >>> client.login(email="email_id", password="password")
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> data = {
 	        >>>     "asset": {
 		    >>>         "title": "Title",
@@ -397,9 +382,8 @@ class Assets(Parameter):
         :return: the result of the `self.client.put()` method call.
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(host='host_name')
-            >>> client.login(email="email_id", password="password")
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> data = {
 	        >>>     "asset": {
 		    >>>         "title": "Title"
@@ -426,9 +410,8 @@ class Assets(Parameter):
         :return: the result of the `client.post` method call.
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(host='host_name')
-            >>> client.login(email="email_id", password="password")
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> data = {
 	        >>>     "asset": {
 		    >>>         "locales": [
@@ -462,9 +445,8 @@ class Assets(Parameter):
         :return: the result of the `post` request made to the specified URL.
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(host='host_name')
-            >>> client.login(email="email_id", password="password")
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> data = {
 	        >>>     "asset": {
 		    >>>         "locales": [
@@ -498,9 +480,8 @@ class Assets(Parameter):
         headers.
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(host='host_name')
-            >>> client.login(email="email_id", password="password")
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> asset = client().stack(api_key='api_key').assets()
             >>> response = asset.folder_collection(folder_uid='folder_uid')
         --------------------------------
@@ -519,9 +500,8 @@ class Assets(Parameter):
         :return: the result of the GET request made by the `self.client.get()` method.
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(host='host_name')
-            >>> client.login(email="email_id", password="password")
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> query = {"is_dir": True, "name": "folder_name"}
             >>> asset = client().stack(api_key='api_key').assets()
             >>> response = asset.folder_collection(query)
@@ -544,9 +524,8 @@ class Assets(Parameter):
         :return: the result of a GET request made by the client.
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(host='host_name')
-            >>> client.login(email="email_id", password="password")
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> query = {"is_dir": True}
             >>> asset = client().stack(api_key='api_key').assets()
             >>> response = asset.folder_collection(folder_uid='folder_uid', query)
@@ -571,9 +550,8 @@ class Assets(Parameter):
         :return: the result of the `self.client.post()` method.
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(host='host_name')
-            >>> client.login(email="email_id", password="password")
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> data = {
 	        >>>     "asset": {
 		    >>>         "name": "Demo"
@@ -599,9 +577,8 @@ class Assets(Parameter):
         :return: the result of the `self.client.put()` method call.
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(host='host_name')
-            >>> client.login(email="email_id", password="password")
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> data = {
 	        >>>     "asset": {
 		    >>>         "name": "Demo"
@@ -625,9 +602,8 @@ class Assets(Parameter):
         :return: the result of the delete request made to the specified URL.
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(host='host_name')
-            >>> client.login(email="email_id", password="password")
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> asset = client().stack(api_key='api_key').assets()
             >>> response = asset.delete(folder_uid='folder_uid')
         --------------------------------

contentstack-management-1.0.1/contentstack_management/auditlogs/__init__.py

@@ -0,0 +1 @@
+import contentstack_management

{contentstack_management-0.0.1 → contentstack-management-1.0.1}/contentstack_management/auditlogs/auditlog.py

@@ -31,13 +31,13 @@ class Auditlog(Parameter):
         -------------------------------
         [Example:]
 
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(authtoken='your_authtoken')
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> result = client.stack("api_key").auditlog().find().json()
 
         -------------------------------
         """  
-        return self.client.get(self.path, headers = self.client.headers)
+        return self.client.get(self.path, headers = self.client.headers, params = self.params)
     
       
     
@@ -48,15 +48,15 @@ class Auditlog(Parameter):
         -------------------------------
         [Example:]
 
-            >>> from contentstack_management import contentstack
-            >>> client = contentstack.client(authtoken='your_authtoken')
+            >>> import contentstack_management
+            >>> client = contentstack_management.Client(authtoken='your_authtoken')
             >>> result = client.stack('api_key').auditlog('log_item_uid').fetch().json()
 
         -------------------------------
         """
         self.validate_uid()
         url = f"{self.path}/{self.log_item_uid}"
-        return self.client.get(url, headers = self.client.headers)
+        return self.client.get(url, headers = self.client.headers, params = self.params)
     
     def validate_uid(self):
         if self.log_item_uid is None or '':

contentstack-management-1.0.1/contentstack_management/branches/__init__.py

@@ -0,0 +1 @@
+import contentstack_management