bashu / wagtail-metadata-mixin Goto Github PK

View Code? Open in Web Editor NEW

46.0 3.0 19.0 108 KB

🔍 OpenGraph, Twitter Card and Schema.org snippet tags for Wagtail CMS pages

License: MIT License

Python 80.11% HTML 19.89%

wagtail django seo django-meta metatags social-network opengraph twitter-card schema-org

wagtail-metadata-mixin's Introduction

wagtail-metadata-mixin

OpenGraph, Twitter Card and Schema.org snippet tags for Wagtail CMS pages.

The current version is tested for compatiblily with the following:

Wagtail versions 2.7 to 2.15
Django versions 2.2 to 3.2
Python versions 3.6 and 3.9

Authored by Basil Shubin, and some great contributors.

Installation

First install the module, preferably in a virtual environment. It can be installed from PyPI:

pip install wagtail-metadata-mixin

Requirements

You must have django-meta installed and configured, see the django-meta documentation for details and setup instructions.

Setup

First make sure the project is configured for django-meta.

Then add the following settings:

INSTALLED_APPS += (
    'wagtailmetadata',
)

and just include meta/meta.html template in your templates

{% load meta %}

<html {% meta_namespaces_schemaorg %}>
    <head {% meta_namespaces %}>
        {% include "meta/meta.html" %}
    </head>
    <body>...</body>
</html>

Check django-meta documentation for more details.

Usage

# models.py

from wagtail.core.models import Page, PageBase

from wagtailmetadata.models import MetadataPageMixin

# ensure MetadataPageMixin class goes before Page class
class CustomPage(MetadataPageMixin, Page):
    schemaorg_type = "Page"

    promote_panels = Page.promote_panels + MetadataPageMixin.panels

Contributing

If you like this module, forked it, or would like to improve it, please let us know! Pull requests are welcome too. :-)

License

wagtail-metadata-mixin is released under the MIT license.

wagtail-metadata-mixin's People

Contributors

Stargazers

Watchers

Forkers

mikhuang mronoffon contraric dadafari hackprinceton gaybro8777 boltaffect boltaffectdev npardington dialinvest sekanitembo yasielcabrera jagarinart jdnfr octavenz siburg

wagtail-metadata-mixin's Issues

incompatible with django-meta 2.0.0

As of Nov 14th, django-meta has been updated with backwards incompatible changes, and produces errors when installed according to the install_requires keyword value provided by the setup.py in wagtail-metadata-mixin (it specifies "django-meta>1.5".)

Attempting to run a wagtail project with wagtail-metadata-mixin now produces this exception:

  File "/usr/local/lib/python3.7/site-packages/wagtailmetadata/models.py", line 9, in <module>
    from meta_mixin.models import ModelMeta
ModuleNotFoundError: No module named 'meta_mixin'

Pinning the version of django-meta in my wagtail project requirements as "django-meta>1.5,<2" instead appears to resolve the problem for now.

RemovedInDjango40Warning: django.utils.translation.ugettext_lazy() is deprecated in favor of django.utils.translation.gettext_lazy()

subj

Wagtail 2.9 / Django 3.0

I created a PR (#9) to support Wagtail 2.9 / Django 3.0. Let me know what you think/if it needs changes. Thanks.

Wagtail version 3+ compatibility

The package is currently limited to wagtail version >1.4 and <3.0. All of those versions are out of support: https://github.com/wagtail/wagtail/wiki/Release-schedule.

I propose to submit a PR that will:

fix the panels in the MetadataPageMixin so it will continue to work with Wagtail versions 3+;
increase minimum requirement for Wagtail to version 2.13, because it's the minimum version that supports Django 3.2;
upgrade the example app to use Django 3.2 and Wagtail 4.1, because those are LTS releases;

I think we could also drop support for Python 3.6, and add support for more recent Python versions.

I propose deploying the changes as a new version 3.0, because it will have breaking changes.