Skip to main content

Contentstack API Client Library for Python

Project description

Contentstack

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.

This SDK uses the 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 or an Authtoken. Read more about it in 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 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.

Installation

Install contentstack pip

pip install contentstack_management

To import the SDK, use the following command:

import contentstack_management

client = contentstack_management.Client(authtoken='your_authtoken')

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.

client = contentstack_management.Client(authtoken= 'your_authtoken')

Login

To Login to Contentstack by using credentials, you can use the following lines of code:

client.login(email="email", password="password")

Management Token

Management Tokens are stack-level tokens, with no users attached to them.

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:

import contentstack_management

client = contentstack_management.Client(authtoken= 'your_authtoken')

Fetch Stack Detail

Use the following lines of code to fetch your stack detail using this SDK:

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:

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:

asset  = {
   upload: 'path/to/file',
   title: 'Asset Title'
}
asset = client().stack(api_key='api_key').assets()
result = asset.upload(asset)

Development Setup

This repository includes Husky-style pre-commit hooks for security scanning and code quality checks. To set up the development environment:

# Install required tools
brew install talisman
brew install snyk/tap/snyk

# Set up Snyk authentication
export SNYK_TOKEN=your_snyk_token_here
snyk auth

# Install git hooks
chmod +x .husky/pre-commit .husky/pre-push .husky/hooks/*.sh .husky/hooks/*.py
cp .husky/pre-commit .git/hooks/pre-commit
cp .husky/pre-push .git/hooks/pre-push
chmod +x .git/hooks/pre-commit .git/hooks/pre-push

Security Features

  • Talisman: Detects secrets and sensitive data in commits
  • Snyk: Scans Python dependencies for vulnerabilities
  • Code Quality: Black, isort, flake8 for consistent code style

Helpful Links

The MIT License (MIT)

Copyright © 2012-2026 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 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

contentstack_management-1.8.0.tar.gz (56.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

contentstack_management-1.8.0-py3-none-any.whl (85.7 kB view details)

Uploaded Python 3

File details

Details for the file contentstack_management-1.8.0.tar.gz.

File metadata

  • Download URL: contentstack_management-1.8.0.tar.gz
  • Upload date:
  • Size: 56.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for contentstack_management-1.8.0.tar.gz
Algorithm Hash digest
SHA256 383fd7ffb6bf66c66c43622119f400f4d927492e96065a13332354b08983e42d
MD5 97b522fed2edcdccd5774b4885043c42
BLAKE2b-256 cf4dcfdb5b73b698b47c39b02d297ccd3f60a59eb945e217d293cb87421669bb

See more details on using hashes here.

File details

Details for the file contentstack_management-1.8.0-py3-none-any.whl.

File metadata

File hashes

Hashes for contentstack_management-1.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 457e9f097e786030aa0d6c90b8d37a28d3fdadcb4be6edfd1715e4690416e2ae
MD5 600ac8dccf8346039d6d1b151f9bbfd2
BLAKE2b-256 b10d2c6d3d76b1c756b22c10aac2d419694de29f4650a67a101a6521de88bf52

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page