Django CMS API - Python

Django CMS is a content management system based on the Django web framework. It provides an API layer that allows developers to interact with the CMS programmatically.

Getting Started

To get started with Django CMS API, you need to have a Django project set up with Django CMS installed. Once you have that, you can start using the CMS API.

CMS API

The CMS API provides a set of Python classes and methods that allow you to interact with the CMS. Here are some of the most commonly used classes and methods:

PluginBase

The PluginBase class is the base class for all CMS plugins. It provides the basic structure for defining a plugin and its settings.

from cms.plugin_base import CMSPluginBase

class MyPlugin(CMSPluginBase):
    pass

CMSPlugin

The CMSPlugin class represents a single instance of a plugin on a page.

from cms.models import CMSPlugin

plugin = CMSPlugin.objects.get(pk=1)

Page

The Page class represents a single page in the CMS.

from cms.models import Page

page = Page.objects.get(pk=1)

Placeholder

The Placeholder class represents a placeholder on a page.

from cms.models import Placeholder

placeholder = Placeholder.objects.get(pk=1)

PlaceholderField

The PlaceholderField class is a Django model field that can be used to store a placeholder on a model.

from django.db import models
from cms.models.fields import PlaceholderField

class MyModel(models.Model):
    my_placeholder = PlaceholderField('my_placeholder')

Conclusion

Django CMS API provides a lot of functionality for interacting with the CMS programmatically. From creating plugins to rendering pages, the API allows you to do just about anything you can do in the CMS interface.