kentico-michaelb / kontent-linked-report

Kontent Konstellations

This is a sample app that uses the Kentico Kontent Python SDK to retrieve content from Kentico Kontent. Plotly and Dash are used to generate a network graph of linked items in a Kontent project.

If you find a bug in the sample or have a feature request, please submit a GitHub issue.

Table of Contents

• Getting started
  • Connecting to your Sample Project
• Features
• Filtering
• Limitations

Getting started

We recommend running this sample application using virtual environment tooling such as virtualenv.

To run the application:

1. Clone the app repository with your favorite GIT client
2. Add your Kontent Project ID key to config.py in the project root - detailed instructions available below
3. Install the project dependencies: pip install -r requirements.txt
4. Run the application: report.py

Connecting to your Sample Project

If you already have a Kentico Kontent account, you can connect this application to your version of the Sample project.

1. In Kentico Kontent, choose Project settings from the app menu
2. Under Development, choose API keys and copy the Project ID
3. Open the config.py file
4. Use the values from your Kentico Kontent project as the project_id value
5. Save the changes

Features

• Nodes can be moved by clicking and dragging.
• Move around the canvas by holding down left-mouse-click in blank space and moving your mouse.
• Hovering over an arrow (edge) between two nodes shows how they are related in the left-hand margin.
• Zooming in/out can be done with your mousewheel when your cursor is positioned over the graph.
• Clicking the "Reset" button will reset the zoom.

Filtering

To leverage the Kontent Python SDK's Filtering:

1. Open network_builder.py
2. Import the Kontent SDK's Filter
3. Replace response = client.get_content_items() with your filtered query.

Example:

from kontent_delivery.builders.filter_builder import Filter

# returns all items of the "article" content type
response = client.get_content_items(
    Filter("system.type", "[eq]", "article")
)

4. Run the application with: report.py

Limitations

• Konstellations uses Kentico Kontent's "items" endpoint, meaning it is limited to a 2000 item response. To change what items are returned, please see the Filtering section of this README.

• The network graph only shows content items from linked items elements in the project. Components and inline content items within rich text editor elements are not included in the report.