Updated Syntax for contentstack client connection (#43) (#44)

* Updated Syntax for contentstack client connection

* Make the code uniformity

* Code uniformity

* Updated Readme file

Author: sunil-lakshman

.talismanrc

@@ -324,4 +324,19 @@ fileignoreconfig:
 - filename: tests/mock/extensions/test_extension_mock.py
   checksum: 88bf3b97761c880dc360e358018150e198117a2acef812d1f9ff4653708f8b5c
 version: ""
-
+fileignoreconfig:
+- filename: contentstack_management/environments/environment.py
+  checksum: f689b0564c0f35929d3a6f086d31baa6ea37c9a7fea3f6dec8988fcfc3a245e3
+- filename: tests/api/environments/test_environments_api.py
+  checksum: 72490f48a6f3346db6a00d80ce78c2dbc55219999270c75dd80d6ab66a8ffb40
+- filename: tests/mock/environments/test_environments_mock.py
+  checksum: b6a2c104b7296034064318c7c9c826bfe81aa84c511fffe8199393a4787f8306
+- filename: tests/unit/environments/test_environment_unit.py
+  checksum: 3a8efa44ba5bfaf4e599d76a0da933cbe883df5a13c3b0edce9d383b50ea4bfe
+- filename: contentstack_management/aliases/aliases.py
+  checksum: 96ebf3aa2256234997d5a50fa78310683b3eb8182f3904d95fa4b155ce0b6f94
+- filename: contentstack_management/branches/branches.py
+  checksum: a02a5821d8dbf0a2e364bbae87ca25d182c6edf56fdceb2e8e7c68874c15f0e4
+- filename: contentstack_management/content_types/content_type.py
+  checksum: 0a00803d139fef0b91ba6f2a38af41bd02e6a8a3390e74f9c8c2b85bf6162d9a
+version: ""

CHANGELOG.md

@@ -4,9 +4,9 @@
 
 ---
 
-## v0.0.1
+## v1.0.0
 
-#### Date: December-23
+#### Date: October-23
 
 ### Initial Release
 

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/__init__.py

@@ -16,7 +16,7 @@
 from .auditlogs.auditlog import Auditlog
 from .environments.environment import Environment
 from .entries.entry import Entry
-from .contentstack import ContentstackClient, Region
+from .contentstack import Client, Region
 from ._api_client import _APIClient
 from .common import Parameter
 from ._errors import ArgumentException
@@ -34,7 +34,7 @@
 
 
 __all__ = (
-"ContentstackClient",
+"Client",
 "Region",
 "_APIClient",
 "Parameter",
@@ -72,7 +72,7 @@
 __author__ = 'ishaileshmishra'
 __status__ = 'debug'
 __region__ = 'na'
-__version__ = '0.0.1'
+__version__ = '1.0.0'
 __host__ = 'api.contentstack.io'
 __protocol__ = 'https://'
 __api_version__ = 'v3'

contentstack_management/aliases/__init__.py

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

contentstack_management/aliases/aliases.py

@@ -25,8 +25,8 @@ def find(self):
         :return: Returns all the aliases
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> alias = contentstack.ContentstackClient().stack(api_key='api_key').alias()
+            >>> import contentstack_management
+            >>> alias = contentstack_management.Client(authtoken='your_authtoken').stack(api_key='api_key').alias()
             >>> response = alias.find()
         --------------------------------
         """
@@ -41,8 +41,8 @@ def fetch(self):
         --------------------------------
 
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> alias = contentstack.ContentstackClient().stack(api_key='api_key').alias('alias_uid')
+            >>> import contentstack_management
+            >>> alias = contentstack_management.Client(authtoken='your_authtoken').stack(api_key='api_key').alias('alias_uid')
             >>> response = alias.fetch()
         --------------------------------
         """
@@ -67,7 +67,7 @@ def assign(self, data):
             >>>            "target_branch": "test"
             >>>            }
             >>>        }
-            >>> alias = contentstack.ContentstackClient().stack(api_key='api_key').alias("alias_uid")
+            >>> alias = contentstack_management.Client(authtoken='your_authtoken').stack(api_key='api_key').alias("alias_uid")
             >>> response = alias.assign(data)
         --------------------------------
         """
@@ -82,8 +82,8 @@ def delete(self):
         :return: Returns status code and message
         --------------------------------
         [Example:]
-            >>> from contentstack_management import contentstack
-            >>> alias = contentstack.ContentstackClient().stack(api_key='api_key').alias(alias_uid="alias_uid")
+            >>> import contentstack_management
+            >>> alias = contentstack_management.Client(authtoken='your_authtoken').stack(api_key='api_key').alias(alias_uid="alias_uid")
             >>> response = alias.delete()
         --------------------------------
         """

contentstack_management/assets/__init__.py

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