Contentstack Delivery 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. Build your application front end, and Contentstack will take care of the rest. Read More.

Contentstack provides Python Delivery SDK to build applications on top of Python. Given below is the detailed guide and helpful resources to get started with our Python Delivery SDK.

This guide will help you get started with Contentstack Python SDK to build apps powered by Contentstack.

• Contentstack account

• Python 3

To use the Contentstack Python SDK with your existing project, perform the following steps:

1. Open the terminal, create a project, and move inside it as follows:
   
   123

   mkdir contentstack-example
   
   cd

2. Create a virtual environment:
   
   1

   python3 -m venv venv

3. Activate the virtual environment:
   
   1

   source  venv/bin/activate

4. Install pip Contentstack as follows:
   
   1

   pip install contentstack

You can download the latest dependency version here

Contentstack offers seven regions AWS North America (AWS NA), AWS Europe (AWS EU), AWS Australia (AWS AU), Azure North America (AZURE NA), Azure Europe (AZURE EU), GCP North America (GCP NA), and GCP Europe (GCP EU) as data centers to store customers' account details and data. These regions are independent of each other and therefore have a dedicated set of instructions to use SDKs offered by Contentstack.

To use SDKs for the Europe, Azure NA, or Azure EU region, you will have to make certain changes in the configuration of the SDK, as detailed below, and the rest of the instructions remain the same.

To initialize the SDK, the stack’s api_key delivery token and the name of the environment where you will publish the content, as shown in the snippet below:

import contentstack
stack = contentstack.Stack(api_key='api_key', delivery_token='delivery_token', environment='environment')

Note: By default, the SDK uses the North American region. Configuration changes are not required for North American region users.

By default, the SDK uses the North American region. Configuration changes are not required for North American region users.

Refer the below code if you want to use the Europe, Azure North America, Azure Europe, GCP North America, or GCP Europe region.

import contentstack
stack = contentstack.Stack("api_key", "delivery_token", "environment", region = "ContentstackRegion.AZURE_EU")

Once you have initialized the SDK, you can query entries to fetch the required content.

For Setting the branch for Europe, Azure North America, Azure Europe, GCP North America, or GCP Europe, refer the code below

For Setting Branch:

If you want to initialize SDK in a particular branch use the code given below:

import contentstack

stack = contentstack.Stack(api_key='api_key', delivery_token='delivery_token',environment= 'environment', branch='branch')

Contentstack SDKs let you interact with the Content Delivery APIs and retrieve content from Contentstack. They are read-only in nature. The SDKs fetch and deliver content from the nearest server via Fastly, our powerful and robust CDN.

Get a Single Entry

To retrieve a single entry from a content type, use the code snippet given below:

import contentstack


stack = contentstack.Stack(api_key='api_key', delivery_token='delivery_token', environment='environment')

contentType = stack.content_type("content_type_uid")

entry = content_type.entry("entry_uid")

response = entry.fetch()

Get Multiple Entries

To retrieve multiple entries of a particular content type, use the code snippet given below:

import contentstack


stack = contentstack.Stack(api_key='api_key', delivery_token='delivery_token', environment='environment')

query = stack.content_type("content_type_uid").query()

response = query.find()

Note By default, the limit for response details per request is 100, with the maximum limit set at 250.

In a single instance, the Get Multiple Entries query will retrieve only the first 100 items of the specified content type. You can paginate and retrieve the rest of the items in batches using the skip and limit parameters in subsequent requests.

stack = contentstack.Stack(api_key='api_key', delivery_token='delivery_token', environment='environment')

query = stack.content_type('content_type_uid').query()

response = query.locale('locale').limit(20).skip(20).find()