Skip to main content

contentstack_utils is a Utility package for Contentstack headless CMS with an API-first approach.

Project description

Contentstack Utility

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


The latest version of PyCharm or Visual Studio Code

Python 3

Create virtual environment

Activate virtual environment

SDK Installation and Setup

To set up Python Utils SDK, Go to terminal and locate the virtual environment path and type below.

   pip install contentstack_utils

If you are using Contentstack Python SDK in your project by running the following commands, then “contentstack_utils” is already imported into your project.

For the latest version

   pip install Contentstack

For the specific version

   pip install Contentstack==1.3.0


Let’s learn how you can use Utils SDK to render embedded items.

Create Render Option

To render embedded items on the front-end, use the renderContents function, and define the UI elements you want to show in the front-end of your website, as shown in the example code below:

    from contentstack_utils.utils import Utils
    from contentstack_utils.render.options import Options

    json_array # should be type of dictionary or list
    rte_content = "html_string"

    callback = Options()
    response = Utils.render_content(rte_content, json_array, callback)

Basic Queries

Contentstack Utils SDK lets you interact with the Content Delivery APIs and retrieve embedded items from the RTE field of an entry.

Fetch Embedded Item(s) from a Single Entry

To get an embedded item of a single entry, you need to provide the stack API key, environment name, content type’s UID, and entry’s UID. Then, use the entry.fetch function as shown below:

    import contentstack

   stack = contentstack.Stack('api_key','delivery_token','environment')
   content_type = stack.content_type("content_type_uid")
   entry = content_type.entry("entry_uid")
   result = entry.fetch()

Fetch Embedded Item(s) from Multiple Entries

To get embedded items from multiple entries, you need to provide the stack API key, delivery token, environment name, and content type’s UID.

    import contentstack

    stack = contentstack.Stack('api_key','delivery_token','environment')
    query = stack.content_type("content_type_uid").query()
    result = query.find()

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_utils-0.1.0.tar.gz (2.8 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page