contentstack-management 0.0.1__tar.gz

contentstack_management-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2012 - 2023 Contentstack. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

contentstack_management-0.0.1/PKG-INFO

@@ -0,0 +1,124 @@
+Metadata-Version: 2.1
+Name: contentstack_management
+Version: 0.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>
+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: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+License-File: LICENSE
+
+[![Contentstack](https://www.contentstack.com/docs/static/images/contentstack.png)](https://www.contentstack.com/)
+
+## Contentstack Management Python SDK
+
+Contentstack is a headless CMS with an API-first approach. It is a CMS that developers can use to build powerful cross-platform applications in their favorite languages. All you have to do is build your application frontend, and Contentstack will take care of the rest. [Read More](https://www.contentstack.com/).
+
+This SDK uses the [Content Management API](https://www.contentstack.com/docs/developers/apis/content-management-api/) (CMA). The CMA is used to manage the content of your Contentstack account. This includes creating, updating, deleting, and fetching content of your account. To use the CMA, you will need to authenticate your users with a [Management Token](https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens) or an [Authtoken](https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken). Read more about it in [Authentication](https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication).
+
+Note: By using CMA, you can execute GET requests for fetching content. However, we strongly recommend that you always use the [Content Delivery API](https://www.contentstack.com/docs/developers/apis/content-delivery-api/) to deliver content to your web or mobile properties.
+
+### Prerequisite
+
+You will need python 3 installed on your machine. You can install it
+from [here](https://www.python.org/ftp/python/3.7.4/python-3.7.4-macosx10.9.pkg).
+
+### Installation
+#### Install contentstack pip
+
+```python
+pip install contentstack_management
+```
+To import the SDK, use the following command:
+```python
+from contentstack_management import contentstack
+
+client = contentstack.ContentstackClient()
+```
+
+### Authentication
+To use this SDK, you need to authenticate your users by using the Authtoken, credentials, or Management Token (stack-level token).
+### Authtoken
+
+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')
+```
+### Login
+To Login to Contentstack by using credentials, you can use the following lines of code:
+```python
+client.login(email="email", password="password")
+
+```
+
+### Management Token
+**Management Tokens** are **stack-level** tokens, with no users attached to them.
+
+```python
+result = client.stack(api_key = 'api_key', management_token= 'management_token' ).content_type('content_type_uid')
+.fetch().json()
+print(result)
+```
+### Contentstack Management Python SDK: 5-minute Quickstart
+#### Initializing Your SDK:
+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
+
+client = contentstack.ContentstackClient(authtoken= 'authtoken')
+```
+#### Fetch Stack Detail
+Use the following lines of code to fetch your stack detail using this SDK:
+```python
+result = client.stack(api_key= 'api_key').fetch().json()
+print(result)
+```
+
+#### Create Entry
+To create an entry in a specific content type of a stack, use the following lines of code:
+
+```python
+entry  = {
+  title: 'Sample Entry',
+  url: '/sampleEntry'
+}
+
+result = client.stack(api_key= 'api_key').content_types('content_type_uid').entry().create(entry)
+print(result.json())
+```
+
+#### Create Asset
+The following lines of code can be used to upload assets to your stack:
+
+```python
+asset  = {
+   upload: 'path/to/file',
+   title: 'Asset Title'
+}
+asset = client().stack(api_key='api_key').assets()
+result = asset.upload(asset)
+```
+
+### Helpful Links
+
+-   [Contentstack Website](https://www.contentstack.com/)
+-   [Official Documentation](https://contentstack.com/docs)
+-   [Content Management API Docs](https://www.contentstack.com/docs/developers/apis/content-management-api)
+
+### The MIT License (MIT)
+Copyright © 2012-2023  [Contentstack](https://www.contentstack.com/). All Rights Reserved
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

contentstack_management-0.0.1/README.md

@@ -0,0 +1,106 @@
+[![Contentstack](https://www.contentstack.com/docs/static/images/contentstack.png)](https://www.contentstack.com/)
+
+## Contentstack Management Python SDK
+
+Contentstack is a headless CMS with an API-first approach. It is a CMS that developers can use to build powerful cross-platform applications in their favorite languages. All you have to do is build your application frontend, and Contentstack will take care of the rest. [Read More](https://www.contentstack.com/).
+
+This SDK uses the [Content Management API](https://www.contentstack.com/docs/developers/apis/content-management-api/) (CMA). The CMA is used to manage the content of your Contentstack account. This includes creating, updating, deleting, and fetching content of your account. To use the CMA, you will need to authenticate your users with a [Management Token](https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens) or an [Authtoken](https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken). Read more about it in [Authentication](https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication).
+
+Note: By using CMA, you can execute GET requests for fetching content. However, we strongly recommend that you always use the [Content Delivery API](https://www.contentstack.com/docs/developers/apis/content-delivery-api/) to deliver content to your web or mobile properties.
+
+### Prerequisite
+
+You will need python 3 installed on your machine. You can install it
+from [here](https://www.python.org/ftp/python/3.7.4/python-3.7.4-macosx10.9.pkg).
+
+### Installation
+#### Install contentstack pip
+
+```python
+pip install contentstack_management
+```
+To import the SDK, use the following command:
+```python
+from contentstack_management import contentstack
+
+client = contentstack.ContentstackClient()
+```
+
+### Authentication
+To use this SDK, you need to authenticate your users by using the Authtoken, credentials, or Management Token (stack-level token).
+### Authtoken
+
+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')
+```
+### Login
+To Login to Contentstack by using credentials, you can use the following lines of code:
+```python
+client.login(email="email", password="password")
+
+```
+
+### Management Token
+**Management Tokens** are **stack-level** tokens, with no users attached to them.
+
+```python
+result = client.stack(api_key = 'api_key', management_token= 'management_token' ).content_type('content_type_uid')
+.fetch().json()
+print(result)
+```
+### Contentstack Management Python SDK: 5-minute Quickstart
+#### Initializing Your SDK:
+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
+
+client = contentstack.ContentstackClient(authtoken= 'authtoken')
+```
+#### Fetch Stack Detail
+Use the following lines of code to fetch your stack detail using this SDK:
+```python
+result = client.stack(api_key= 'api_key').fetch().json()
+print(result)
+```
+
+#### Create Entry
+To create an entry in a specific content type of a stack, use the following lines of code:
+
+```python
+entry  = {
+  title: 'Sample Entry',
+  url: '/sampleEntry'
+}
+
+result = client.stack(api_key= 'api_key').content_types('content_type_uid').entry().create(entry)
+print(result.json())
+```
+
+#### Create Asset
+The following lines of code can be used to upload assets to your stack:
+
+```python
+asset  = {
+   upload: 'path/to/file',
+   title: 'Asset Title'
+}
+asset = client().stack(api_key='api_key').assets()
+result = asset.upload(asset)
+```
+
+### Helpful Links
+
+-   [Contentstack Website](https://www.contentstack.com/)
+-   [Official Documentation](https://contentstack.com/docs)
+-   [Content Management API Docs](https://www.contentstack.com/docs/developers/apis/content-management-api)
+
+### The MIT License (MIT)
+Copyright © 2012-2023  [Contentstack](https://www.contentstack.com/). All Rights Reserved
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

contentstack_management-0.0.1/contentstack_management/__init__.py

@@ -0,0 +1,58 @@
+"""The __init__.py file that contains modules that need to import"""
+
+from .organizations.organization import Organization
+from .stack.stack import Stack
+from .user_session.user_session import UserSession
+from .users.user import User
+from .aliases.aliases import Alias
+from .assets.assets import Assets
+from .branches.branches import Branch
+from .content_types.content_type import ContentType
+from .global_fields.global_fields import GlobalFields
+from .webhooks.webhook import Webhook
+from .workflows.workflows import Workflows
+from .metadata.metadata import Metadata
+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 ._api_client import _APIClient
+from .common import Parameter
+from ._errors import ArgumentException
+
+__all__ = (
+"ContentstackClient",
+"ContentstackRegion",
+"_APIClient",
+"Parameter",
+"ArgumentException",
+"Organization",
+"Stack",
+"UserSession",
+"User",
+"Alias",
+"Assets",
+"Branch",
+"ContentType",
+"GlobalFields",
+"Webhook",
+"Workflows",
+"Metadata",
+"Roles",
+"Auditlog",
+"Environment",
+"Entry",
+)
+
+__title__ = 'contentstack-management-python'
+__author__ = 'ishaileshmishra'
+__status__ = 'debug'
+__region__ = 'na'
+__version__ = '0.0.1'
+__host__ = 'api.contentstack.io'
+__protocol__ = 'https://'
+__api_version__ = 'v3'
+__endpoint__ = 'https://api.contentstack.io/v3/'
+__email__ = 'mobile@contentstack.com'
+__issues__ = 'support@contentstack.com'

contentstack_management-0.0.1/contentstack_management/_api_client.py

@@ -0,0 +1,153 @@
+import requests
+
+
+class _APIClient:
+    def __init__(self, endpoint, headers, timeout=30, max_retries: int = 5):
+        """
+        The function is a constructor that initializes the endpoint, headers, timeout, and max_retries
+        attributes of an object.
+        
+        :param endpoint: The `endpoint` parameter is the URL or address of the API endpoint that you
+        want to connect to. It is the destination where you will send your requests and receive
+        responses from
+        :param headers: The `headers` parameter is used to pass any additional headers that need to be
+        included in the HTTP request. Headers are used to provide additional information about the
+        request, such as authentication credentials or content type
+        :param timeout: The `timeout` parameter specifies the maximum amount of time (in seconds) that
+        the request should wait for a response before timing out, defaults to 30 (optional)
+        :param max_retries: The `max_retries` parameter is an integer that specifies the maximum number
+        of times a request should be retried if it fails. If a request fails, the code will attempt to
+        retry the request up to `max_retries` times before giving up, defaults to 5
+        :type max_retries: int (optional)
+        """
+        
+        self.endpoint = endpoint
+        self.headers = headers
+        self.timeout = timeout
+        self.max_retries = max_retries
+        pass
+
+    def _call_request(self, method, url, headers: dict = None, params=None, data=None, json_data=None, files=None):
+        """
+        The function `_call_request` sends an HTTP request using the specified method, URL, headers,
+        parameters, data, and JSON data, and returns the response as a JSON object.
+        
+        :param method: The HTTP method to be used for the request (e.g., GET, POST, PUT, DELETE, etc.)
+        :param url: The `url` parameter is a string that represents the URL of the API endpoint that you
+        want to make a request to
+        :param headers: The `headers` parameter is a dictionary that contains the HTTP headers to be
+        included in the request. These headers provide additional information about the request, such as
+        the content type or authentication credentials
+        :type headers: dict
+        :param params: The `params` parameter is used to pass query parameters in the URL. These
+        parameters are used to filter or modify the response from the server. For example, if you are
+        making a request to an API that returns a list of users, you can use the `params` parameter to
+        specify the number
+        :param data: The `data` parameter is used to send data in the body of the request. It is
+        typically used for sending form data or other types of data that are not in JSON format
+        :param json_data: The `json_data` parameter is used to send a JSON payload in the request. It is
+        typically used when making a POST or PUT request to send data to the server in JSON format. The
+        `json_data` parameter should be a dictionary that will be converted to JSON before sending the
+        request
+        :return: the JSON response from the HTTP request.
+        """
+        
+        # headers.update(self.headers)
+        response = requests.request(
+            method, url, headers=headers, params=params, data=data, json=json_data, files=files)
+        # response.raise_for_status()
+        return response
+
+    def get(self, path, params=None, headers=None):
+        """
+        The function sends a GET request to a specified URL with optional parameters and headers.
+        
+        :param path: The path parameter is a string that represents the endpoint or path of the API that
+        you want to make a GET request to. For example, if you want to make a GET request to the
+        "/users" endpoint, you would pass "/users" as the path parameter
+        :param params: The `params` parameter is used to pass query parameters in the URL. These
+        parameters are used to filter or modify the data being requested from the server. For example,
+        if you want to retrieve only the data for a specific user, you can pass the user ID as a query
+        parameter
+        :param headers: The `headers` parameter is a dictionary that contains any additional headers
+        that you want to include in the HTTP request. These headers can be used to provide additional
+        information to the server, such as authentication credentials or content type. If no headers are
+        provided, the `headers` parameter will default to `None
+        :return: The method is returning the result of the `_call_request` method.
+        """
+
+        url = f"{self.endpoint}{path}"
+        # self.headers = headers or {}
+        return self._call_request('GET', url, headers=headers, params=params)
+
+    def put(self, path, data=None, params=None, json_data=None, headers=None, files=None):
+        """
+        The function sends a PUT request to a specified URL with optional data, parameters, JSON data,
+        and headers.
+        
+        :param path: The path parameter is the endpoint or URL path where the PUT request will be sent
+        to. It specifies the location of the resource that needs to be updated or modified
+        :param data: The `data` parameter is used to pass the request body data in the form of a string.
+        It is typically used for sending data in formats like JSON or XML
+        :param params: The `params` parameter is used to pass query parameters in the URL. These
+        parameters are used to filter or modify the data being requested from the server
+        :param json_data: The `json_data` parameter is used to pass JSON data in the request body. It is
+        typically used when making a PUT request to update or modify a resource on the server. The JSON
+        data should be a dictionary or a JSON serializable object
+        :param headers: The `headers` parameter is used to specify any additional headers that should be
+        included in the HTTP request. Headers are used to provide additional information about the
+        request, such as the content type or authentication credentials
+        :return: the result of calling the `_call_request` method with the specified parameters.
+        """
+        
+        url = f"{self.endpoint}{path}"
+        # headers = headers or {}
+        return self._call_request('PUT', url, headers=headers, params=params, data=data, json_data=json_data, files=files)
+
+    def post(self, path, data=None, json_data=None, headers=None, params=None, files=None):
+        """
+        The function sends a POST request to a specified URL with optional data, headers, and
+        parameters.
+        
+        :param path: The path parameter is the endpoint or URL path where the POST request will be sent
+        to. It is appended to the base URL or endpoint of the API
+        :param data: The `data` parameter is used to pass data in the request body. It can be a
+        dictionary, bytes, or a file-like object. This parameter is typically used for sending form data
+        or other types of data that are not in JSON format
+        :param json_data: The `json_data` parameter is used to pass JSON data in the request body. It is
+        typically used when sending data to an API that expects JSON data
+        :param headers: The `headers` parameter is used to specify any additional headers that should be
+        included in the HTTP request. Headers are used to provide additional information about the
+        request, such as the content type or authentication credentials
+        :param params: The `params` parameter is used to pass query parameters in the URL. Query
+        parameters are used to filter or sort the data being requested from the server. They are
+        appended to the URL after a question mark (?) and separated by ampersands (&). For example, if
+        you have a `params`
+        :return: The method is returning the result of the `_call_request` method.
+        """
+        
+        url = f"{self.endpoint}{path}"
+        # 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):
+        """
+        The function sends a DELETE request to a specified URL with optional headers and parameters.
+        
+        :param path: The `path` parameter is a string that represents the path of the resource you want
+        to delete. It is appended to the base URL to form the complete URL for the DELETE request
+        :param headers: The `headers` parameter is a dictionary that contains any additional headers
+        that you want to include in the DELETE request. These headers can be used to provide additional
+        information or authentication credentials to the server. If no headers are provided, the value
+        of `headers` will be set to `None`
+        :param params: The `params` parameter is used to pass query parameters in the URL. Query
+        parameters are used to filter or modify the data being requested. They are appended to the URL
+        after a question mark (?) and separated by ampersands (&). For example, if you want to filter
+        the data by a specific
+        :return: The method is returning the result of the `_call_request` method, which is the response
+        from the DELETE request made to the specified URL.
+        """
+        
+        url = f"{self.endpoint}{path}"
+        # headers = headers or {}
+        return self._call_request('DELETE', url, headers=headers, params=params)

contentstack_management-0.0.1/contentstack_management/_constant.py

@@ -0,0 +1,58 @@
+import platform
+import sys 
+
+
+def _default_user_agent():
+    """
+    The function `_default_user_agent()` returns a dictionary containing information about the user
+    agent, including the SDK, app, platform, and operating system.
+    :return: a dictionary containing information about the user agent.
+    """
+
+    header = {
+        'sdk': {
+            'name': 'contentstack-management.python',
+            'version': sys.version_info
+        },
+        'app': {
+            'name': 'contentstack-management.python',
+            'version': '1.0.0'
+        },
+        'platform': {
+            'name': 'python',
+            'version': platform.python_version()
+        }
+    }
+
+    os_name = platform.system()
+    if os_name == 'Darwin':
+        os_name = 'macOS'
+    elif not os_name or os_name == 'Java':
+        os_name = None
+    elif os_name not in ['macOS', 'Windows']:
+        os_name = 'Linux'
+
+    header['os'] = {
+        'name': os_name,
+        'version': platform.release() if os_name else None
+    }
+
+    return header
+
+
+def _request_headers():
+    """
+    The function `_request_headers` returns a dictionary of headers for an HTTP request.
+    :return: a dictionary containing the headers for a HTTP request.
+    """
+    
+    headers = {
+        'X-User-Agent': _default_user_agent(),
+        'Content-Type':
+            'application/json',
+    }
+    return headers
+
+
+if __name__ == '__main__':
+    print(_request_headers().__str__())

contentstack_management-0.0.1/contentstack_management/_errors.py

@@ -0,0 +1,10 @@
+class ArgumentException(Exception):
+
+    pass
+    def __init__(self, f, *args):
+        super().__init__(args)
+        self.f = f
+
+    def __str__(self):
+        return self.f
+

contentstack_management-0.0.1/contentstack_management/aliases/__init__.py

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

contentstack_management-0.0.1/contentstack_management/aliases/aliases.py

@@ -0,0 +1,91 @@
+"""An alias acts as a pointer to a particular branch. You can specify the alias ID in your 
+frontend code to pull content from the target branch associated with an alias."""
+
+import json
+from ..common import Parameter
+_path = 'stacks/branch_aliases'
+
+
+class Alias(Parameter):
+    """An alias acts as a pointer to a particular branch. You can specify the alias ID in your
+    frontend code to pull content from the target branch associated with an alias."""
+
+    def __init__(self, client, alias_uid=None):
+        self.client = client
+        self.alias_uid = alias_uid
+        super().__init__(self.client)
+
+    def find(self):
+        r"""
+        The Get all aliases request returns comprehensive information of all the 
+        aliases available in a particular stack in your account.
+        :params limit: {int} -- A limit on the number of objects to return.
+        :params skip: {int} -- The number of objects to skip before returning any.
+        :params include_count: {bool}
+        :return: Returns all the aliases
+        --------------------------------
+        [Example:]
+            >>> from contentstack_management import contentstack
+            >>> branch = contentstack.ContentstackClient().stack(api_key='api_key').branch_alias()
+            >>> response = branch.find()
+        --------------------------------
+        """
+        return self.client.get(_path, headers=self.client.headers, params=self.params)
+
+    def fetch(self):
+        r"""
+        The Get a single alias request returns information of a specific alias.
+
+        :return: Returns the aliase of the given UID
+    
+        --------------------------------
+
+        [Example:]
+            >>> from contentstack_management import contentstack
+            >>> branch = contentstack.ContentstackClient().stack(api_key='api_key').branch_alias('branch_alias_uid')
+            >>> response = branch.fetch()
+        --------------------------------
+        """
+        if self.alias_uid is None or '':
+            raise Exception('alias_uid is required')
+        url = f"{_path}/{self.alias_uid}"
+        return self.client.get(url, headers=self.client.headers, params=self.params)
+
+    def assign(self, data):
+        r"""
+        The Assign an alias request creates a new alias in a particular stack of your organization. 
+        This alias can point to any existing branch (target branch) of your stack.
+
+        :param data: {json} -- Data required in json format to assign an alias
+        :return: Returns an alias with the given data
+        --------------------------------
+
+        [Example:]
+            >>> from contentstack import contentstack
+            >>> body = {
+            >>>        "branch_alias": {
+            >>>            "target_branch": "test"
+            >>>            }
+            >>>        }
+            >>> branch = contentstack.ContentstackClient().stack(api_key='api_key').alias("alias_uid")
+            >>> response = branch.assign(data)
+        --------------------------------
+        """
+        url = f"{_path}/{self.alias_uid}"
+        body = json.dumps(data)
+        return self.client.put(url, headers=self.client.headers, data=body)
+
+    def delete(self):
+        r"""
+        The Delete BranchAlias call is used to delete an existing BranchAlias permanently from your Stack.
+        :params force: {bool}
+        :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()
+        --------------------------------
+        """
+        url = f"{_path}/{self.alias_uid}"
+        return self.client.delete(url, headers=self.client.headers, params=self.params)

contentstack_management-0.0.1/contentstack_management/assets/__init__.py

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