Skip to main content

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


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

wagtail_related-0.1.0-py3-none-any.whl (16.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page