Finally a system that can move at the speed of your imagination.
Build the tech stack that you've always dreamed of, on your terms.
.png?format=pjpg&auto=webp)
best-in-class experiences
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.
To use the Contentstack Python SDK with your existing project, perform the following steps:
mkdir contentstack-example cd
python3 -m venv venv
source venv/bin/activate
pip install contentstack
You can download the latest dependency version here
Contentstack offers three regions (North America (NA), Europe (EU), and Azure North America (NA) 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 and Azure NA 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.
To set the European or Azure North American region, refer to the code below:
import contentstack
config = Config()
config.region = ContentstackRegion.<add_your_region>;
stack = contentstack.Stack(api_key="api_key", delivery_token="delivery_token",environment= "environment", config)
For Setting the branch for Europe or Azure North America, check the
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()
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()
Retrieves stack
| Name | Type | Description |
|---|---|---|
headers (required) | dict | |
sync_param | dict | |
endpoint | str | |
api_key (required) | str | |
delivery_token (required) | str | |
environment (required) | str | |
host | str | |
version | str | |
region | Region | |
timeout | int | |
branch | str | |
retry_strategy | Retry | |
live_preview_dict | dict |
live_preview_query accepts key-value pair objects to the query
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
response = stack.live_preview_query(**kwargs)
print(response)
Image Delivery API covers the parameters that you can add to the URL to retrieve, manipulate (or convert) image files and display it to your web or mobile properties.
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
response = stack.image_transform("image_url", **kwargs)
print(response)
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
response = stack.sync_token("sync_token")
print(response)
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
response = stack.pagination("
")
print(response)
initial sync of the stack
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
response = stack.
(
)
print(
)
assets of the stack
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
assets = stack.asset_query()
print(
)
asset of the stack
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
asset = stack.asset("uid")
print(asset)
live_preview for the stack
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
result = stack.get_live_preview
print(result)
headers for the stack
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
result = stack.get_headers
print(result)
branch for the stack
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
result = stack.get_branch
print(result)
environment for the stack
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
result = stack.get_environment
print(result)
Delivery Token for the stack
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
result = stack.get_delivery_token
print(result)
api_key for the stack
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment)
result = stack.get_api_key
print(result)
Retrieves a single asset, specify its UID.
| Name | Type | Description |
|---|---|---|
uid | str | Readonly property to check value of asset’s uid |
This call fetches the latest version of a specific asset of a particular stack
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
asset = stack.asset(uid='asset_uid')
response = asset.fetch()
Retrieve the published content of the fallback locale if an entry is not localized in specified locale
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
asset = stack.asset(uid='asset_uid')
asset = asset.include_fallback()
Include the dimensions (height and width) of the image in the response. Supported image types: JPG, GIF, PNG, WebP, BMP, TIFF, SVG, and PSD
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
asset = stack.asset(uid='asset_uid')
asset = asset.include_dimension()
Include the relative URLs of the assets in the response
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
asset = stack.asset(uid='asset_uid')
asset = asset.relative_urls()
Provide the name of the environment if you wish to retrieve the assets published in a particular environment
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
asset = stack.asset(uid='asset_uid')
asset = asset.environment('environment_name')
params is used to pass additional parameters to the asset query
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
asset = stack.asset(uid='asset_uid')
asset = asset.param('key', 'value')
Removes environment from the request params
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
asset = stack.asset(uid='asset_uid')
asset = asset.
('production')
Retrieves Assets
| Name | Type | Description |
|---|---|---|
asset_query_params | dict | Readonly property to get data of entry. |
This call fetches the list of all the assets of a particular stack. It also returns the content of each asset in dict format.
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
asset_query = stack.asset_query()
response = stack.asset_query().find()
Enter locale code. e.g., en-us
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
asset_query = stack.asset_query()
stack.asset_query().locale("locale_code")
Retrieve the published content of the fallback locale if an entry is not localized in specified locale
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
asset_query = stack.asset_query()
stack.asset_query().
()
include the relative URLs of the assets in the response
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
asset_query = stack.asset_query()
stack.asset_query().relative_url()
Includes branch in the response
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
asset_query = stack.asset_query()
stack.asset_query().
()
Specify the version number of the asset that you wish to retrieve. If the version is not specified, the details of the latest version will be retrieved. To retrieve a specific version, keep the environment parameter blank
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
asset_query = stack.asset_query()
asset_query.version(version)
Provide the name of the environment if you wish to retrieve the assets published in a particular environment
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
We can query on entry of specified ContentType
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
content_type = stack.content_type('content_type_uid')
query = content_type.query()
This method is useful to fetch ContentType of the stack
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
content_type = stack.content_type('content_type_uid')
response = content_type.fetch()
This method is useful to fetch ContentType of the of the stack.
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
content_type = stack.content_type('content_type_uid')
response = content_type.find()
An entry is the actual piece of content created using one of the defined content types
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
content_type = stack.content_type('content_type_uid')
entry = content_type.entry(uid='entry_uid')
Retrieves assets
| Name | Type | Description |
|---|---|---|
entry_params | dict | Readonly property to get data of entry. |
content_type_id | str | |
entry_uid | str | |
base_url | str |
Fetches the latest version of the entries from stack
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
content_type = stack.content_type('content_type_uid')
entry = content_type.entry(uid='entry_uid')
response = entry.fetch()
include_embedded_items instance of Entry include_embedded_objects (Entries and Assets) along with entry/entries details
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
content_type = stack.content_type('content_type_uid')
entry = content_type.entry(uid='entry_uid')
entry.include_embedded_items()
Retrieve the published pranch in the entry response
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
content_type = stack.content_type('content_type_uid')
entry = content_type.entry(uid='entry_uid')
entry.include_branch()
Retrieve the published content of the fallback locale if an entry is not localized in specified locale
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
content_type = stack.content_type('content_type_uid')
entry = content_type.entry(uid='entry_uid')
entry.
This method is useful to add additional Query parameters to the entry
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
content_type = stack.content_type('content_type_uid')
entry = content_type.entry(uid='entry_uid')
entry.param("key", "value")
When no version is specified, it returns the latest version, To retrieve a specific version, specify the version number under this parameter. In such a case, DO NOT specify any environment
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
content_type = stack.content_type('content_type_uid')
entry = content_type.entry(uid='entry_uid')
entry.version(number)
Enter the name of the environment of which the entries needs to be included
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
content_type = stack.content_type('content_type_uid')
entry = content_type.entry(uid='entry_uid')
entry.environment('environment_name')
Retrieves assets
| Name | Type | Description |
|---|---|---|
content_type_uid | str | |
base_url | str |
Adds key value pairs to the to the query parameters
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
content_type = stack.content_type('content_type_uid')
query = content_type.query()
query = query.query("key":"value")
Adds Query Parameters to the to the request
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
content_type = stack.content_type('content_type_uid')
query = content_type.query()
query = query.addParam({"key":"value"})
Adds Query Parameters to the to the request
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
content_type = stack.content_type('content_type_uid')
query = content_type.query()
query = query.param("key", "value")
you can sort them in the descending order with respect to the value of a specific field in the response body
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
content_type = stack.content_type('content_type_uid')
query = content_type.query()
query.order_by_descending("key")
you can sort them in the ascending order with respect to the value of a specific field in the response body.
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
content_type = stack.content_type('content_type_uid')
query = content_type.query()
query.order_by_ascending("key")
A limit on the number of objects to return./p>
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
content_type = stack.content_type('content_type_uid')
query = content_type.query()
query.limit(count)
The number of objects to skip before returning any. skip_count No of objects to skip from returned objects
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
content_type = stack.content_type('content_type_uid')
query = content_type.query()
query.skip(count)
Retrieve count and data of objects in result
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
content_type = stack.content_type('content_type_uid')
query = content_type.query()
query.include_count()
Get entries containing the field values matching the condition in the query
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
content_type = stack.content_type('content_type_uid')
query = content_type.query("
",
)
query.where()
This method adds key and value to the Query
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
query = stack.content_type("content_type_uid").query()
query.add_param("key","value")
This method also includes the content type UIDs of the referenced entries returned in the response
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
query = stack.content_type("content_type_uid").query()
query.
()
This method also includes the ContentType in the entry
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
query = stack.content_type("content_type_uid").query()
query.include_content_type()
When you fetch an entry of a content type that has a reference field, by default, the content of the referred entry is not fetched. It only fetches the UID of the referred entry, along with the content of the specified entry
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
query = stack.content_type("content_type_uid").query()
query.include_reference()
Specifies list of field_uid that would be excluded from the response. It refers to the top-level fields of the schema
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
query = stack.content_type("content_type_uid").query()
query.
()
Specifies an array of only keys in BASE object that would be included in the response. It refers to the top-level fields of the schema
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
query = stack.content_type("content_type_uid").query()
query.only()
It fetches single query response
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
query = stack.content_type("content_type_uid").query()
response = query.find_one()
Language code of which the entries need to be included. Only the entries published in this locale will be displayed
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
query = stack.content_type("content_type_uid").query()
response = query.locale()
It fetches the query response
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
query = stack.content_type("content_type_uid").query()
response = query.find()
Retrieve the published pranch in the response
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
query = stack.content_type("content_type_uid").query()
query.include_embedded_items()
Retrieve the published pranch in the response
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
query = stack.content_type("content_type_uid").query()
query.
()
Retrieve the published content of the fallback locale if an entry is not localized in specified locale
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
query = stack.content_type("content_type_uid").query()
Get entries having values based on referenced fields. This query works the opposite of $in_query and retrieves all entries that does not satisfy query conditions made on referenced fields.
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
query = stack.content_type("content_type_uid").query()
query.where_not_in("brand")
Get entries having values based on referenced fields. This query retrieves all entries that satisfy the query conditions made on referenced fields
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
query = stack.content_type("content_type_uid").query()
query = query.where_in("brand")
This method provides only the entries matching the specified value.
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
query = stack.content_type("content_type_uid").query()
query = query.search("search_keyword")
Include tags with which to search entries that accept variable-length argument lists
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
response = query.fetch()
query_operator Get entries that satisfy all the conditions provided in the '$and' query.
import contentstack;
stack = contentstack.Stack(api_key, delivery_token, environment);
query1 = stack.content_type("content_type_uid_1").query()
query2 = self.query1.where("price", QueryOperation.IS_LESS_THAN, fields=90)