django-wordpress: Integrate WordPress Content into Django

Introduction

django-wordpress is a powerful Django package designed to integrate WordPress content directly into your Django applications. Developed by ISL and the Sunlight Foundation, it provides models and views for reading data from a WordPress database, compatible with WordPress version 3.5 and above.

A key feature is its read-only design by default, protecting your WordPress content from accidental modifications. While writing can be enabled, it's strongly advised against due to the lack of WordPress-specific logic. The package also supports custom WordPress table prefixes and multiple database configurations, offering flexibility for various setups. Default templates are included for development, encouraging users to override them for production.

Installation

To get started with django-wordpress, follow these simple steps:

First, install the package using pip:

pip install the-real-django-wordpress

Next, add 'wordpress' to your INSTALLED_APPS in settings.py:

INSTALLED_APPS = [
    # ...
    'wordpress',
    # ...
]

Finally, include the WordPress URLs in your project's urls.py:

from django.urls import path, include

urlpatterns = [
    # ...
    path('path/to/blog/', include('wordpress.urls')),
    # ...
]

If you are using multiple databases, remember to configure your database routers:

DATABASE_ROUTERS = ['wordpress.router.WordpressRouter']

Examples

Working with WordPress models is straightforward. Here are a few common examples:

Retrieve the ten most recent published posts:

from wordpress.models import Posts
Posts.objects.published()[:10]

Find posts tagged "wordpress":

from wordpress.models import Posts
Posts.objects.term("wordpress")

Access attachments for a specific post:

for attachment in post.attachments():
    # Process attachment
    pass

Get all tags associated with a post:

post.tags()

Why Use django-wordpress?

django-wordpress offers several compelling reasons for integration:

• Seamless Integration: Easily bring your existing WordPress blog content into a Django application without complex migrations or data duplication.
• Data Safety: Its default read-only mode provides a secure way to access WordPress data, minimizing the risk of unintended changes to your live WordPress site.
• Flexibility: Supports custom table prefixes and multiple database configurations, adapting to diverse WordPress setups.
• Export Capabilities: Includes management commands like wpexport to dump published posts in WXR format and wpexportauthors to export authors as CSV.
• Developer Friendly: Provides a clear API for querying WordPress data using Django's ORM.

Links

• GitHub Repository: jcarbaugh/django-wordpress