|
1 | | -# contentstack-management-python |
| 1 | +[](https://www.contentstack.com/) |
| 2 | + |
| 3 | +## Contentstack Management Python SDK |
| 4 | + |
| 5 | +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/). |
| 6 | + |
| 7 | +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). |
| 8 | + |
| 9 | +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. |
| 10 | + |
| 11 | +### Prerequisite |
| 12 | + |
| 13 | +You will need python 3 installed on your machine. You can install it |
| 14 | +from [here](https://www.python.org/ftp/python/3.7.4/python-3.7.4-macosx10.9.pkg). |
| 15 | + |
| 16 | +### Installation |
| 17 | +#### Install contentstack pip |
| 18 | + |
| 19 | +```python |
| 20 | +pip install contentstack_management |
| 21 | +``` |
| 22 | +To import the SDK, use the following command: |
| 23 | +```python |
| 24 | +from contentstack_management import contentstack |
| 25 | + |
| 26 | +client = contentstack.ContentstackClient() |
| 27 | +``` |
| 28 | + |
| 29 | +### Authentication |
| 30 | +To use this SDK, you need to authenticate your users by using the Authtoken, credentials, or Management Token (stack-level token). |
| 31 | +### Authtoken |
| 32 | + |
| 33 | +An **Authtoken** is a read-write token used to make authorized CMA requests, and it is a **user-specific** token. |
| 34 | +```python |
| 35 | +client = contentstack.ContentstackClient(authtoken= 'authtoken') |
| 36 | +``` |
| 37 | +### Login |
| 38 | +To Login to Contentstack by using credentials, you can use the following lines of code: |
| 39 | +```python |
| 40 | +client.login(email="email", password="password") |
| 41 | + |
| 42 | +``` |
| 43 | + |
| 44 | +### Management Token |
| 45 | +**Management Tokens** are **stack-level** tokens, with no users attached to them. |
| 46 | + |
| 47 | +```python |
| 48 | +result = client.stack(api_key = 'api_key', management_token= 'management_token' ).content_type('content_type_uid') |
| 49 | +.fetch().json() |
| 50 | +print(result) |
| 51 | +``` |
| 52 | +### Contentstack Management Python SDK: 5-minute Quickstart |
| 53 | +#### Initializing Your SDK: |
| 54 | +To use the Python CMA SDK, you need to first initialize it. To do this, use the following code: |
| 55 | + |
| 56 | +```python |
| 57 | +from contentstack_management import contentstack |
| 58 | + |
| 59 | +client = contentstack.ContentstackClient(authtoken= 'authtoken') |
| 60 | +``` |
| 61 | +#### Fetch Stack Detail |
| 62 | +Use the following lines of code to fetch your stack detail using this SDK: |
| 63 | +```python |
| 64 | +result = client.stack(api_key= 'api_key').fetch().json() |
| 65 | +print(result) |
| 66 | +``` |
| 67 | + |
| 68 | +#### Create Entry |
| 69 | +To create an entry in a specific content type of a stack, use the following lines of code: |
| 70 | + |
| 71 | +```python |
| 72 | +entry = { |
| 73 | + title: 'Sample Entry', |
| 74 | + url: '/sampleEntry' |
| 75 | +} |
| 76 | + |
| 77 | +result = client.stack(api_key= 'api_key').content_types('content_type_uid').entry().create(entry) |
| 78 | +print(result.json()) |
| 79 | +``` |
| 80 | + |
| 81 | +#### Create Asset |
| 82 | +The following lines of code can be used to upload assets to your stack: |
| 83 | + |
| 84 | +```python |
| 85 | +asset = { |
| 86 | + upload: 'path/to/file', |
| 87 | + title: 'Asset Title' |
| 88 | +} |
| 89 | +asset = client().stack(api_key='api_key').assets() |
| 90 | +result = asset.upload(asset) |
| 91 | +``` |
| 92 | + |
| 93 | +### Helpful Links |
| 94 | + |
| 95 | +- [Contentstack Website](https://www.contentstack.com/) |
| 96 | +- [Official Documentation](https://contentstack.com/docs) |
| 97 | +- [Content Management API Docs](https://www.contentstack.com/docs/developers/apis/content-management-api) |
| 98 | + |
| 99 | +### The MIT License (MIT) |
| 100 | +Copyright © 2012-2023 [Contentstack](https://www.contentstack.com/). All Rights Reserved |
| 101 | + |
| 102 | +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: |
| 103 | + |
| 104 | +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. |
| 105 | + |
| 106 | +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. |
0 commit comments