Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

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

Project description

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.

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for wagtail-related, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size wagtail_related-0.1.0-py3-none-any.whl (16.4 kB) File type Wheel Python version py3 Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page