Skip to main content

wagtailrelated

A module for Wagtail that finds related pages and tags for your pages.

How to install

Install using pip:

pip install wagtail-related

Settings

In your settings file, add wagtailrelated to INSTALLED_APPS:

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

URL configuration

Include API url into your urlpatterns:

urlpatterns = [
    # ...
    url(r'^api/more-like-this', include('wagtailrelated.api.urls')),
    # ...

Backend settings

Add the following setting into your project:

WAGTAIL_RELATED_BACKENDS = {
    'default': {
        'BACKEND': 'wagtailrelated.backends.elasticsearch5',
    }
}

Note that the module uses Elasticsearch to find related pages and relies on Wagtail's built-in search backend. This means that you should have the WAGTAILSEARCH_BACKENDS setting comfigured with wagtail.search.backends.elasticsearch5 in your project.

Settings shown in this instruction will work fine, if your Elasticsearch 5 backend exists under the default key. If your project has multiple Wagtail search backends and your Elasticsearch 5 search backend has different key, see how you need to modify WAGTAIL_RELATED_BACKENDS here.

How to use

The package provides an API to get related pages. See the API documentation.

Release files for wagtail-related 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for wagtail-related 0.1.0
File Interpreter ABI Platform
wagtail_related-0.1.0-py3-none-any.whl Python 3 none any Details

Release history Release notifications | RSS feed

This release

0.1.0 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page