Metadata-Version: 2.1
Name: wagtail-metadata-mixin
Version: 0.1.0
Summary: OpenGraph, Twitter Card and Schema.org snippet tags for Wagtail CMS pages
Home-page: https://github.com/bashu/wagtail-metadata-mixin
Author: Basil Shubin
Author-email: basil.shubin@gmail.com
License: MIT License
Download-URL: https://github.com/bashu/wagtail-metadata-mixin/zipball/master
Description: wagtail-metadata-mixin
        ======================
        
        OpenGraph, Twitter Card and Schema.org snippet tags for Wagtail CMS pages
        
        Authored by `Basil Shubin <https://github.com/bashu>`_,  and some great
        `contributors <https://github.com/bashu/wagtail-metadata-mixin/contributors>`_.
        
        .. image:: https://img.shields.io/pypi/v/wagtail-metadata-mixin.svg
            :target: https://pypi.python.org/pypi/wagtail-metadata-mixin/
        
        .. image:: https://img.shields.io/pypi/dm/wagtail-metadata-mixin.svg
            :target: https://pypi.python.org/pypi/wagtail-metadata-mixin/
        
        .. image:: https://img.shields.io/github/license/bashu/wagtail-metadata-mixin.svg
            :target: https://pypi.python.org/pypi/wagtail-metadata-mixin/
        
        .. image:: https://img.shields.io/travis/bashu/wagtail-metadata-mixin.svg
            :target: https://travis-ci.com/bashu/wagtail-metadata-mixin/
        
        Compatibility
        -------------
        
        The current version is tested for compatiblily with the following:
        
        - Wagtail versions 2.7 to 2.11
        - Django versions 2.2 to 3.2
        - Python versions 3.6 and 3.9
        
        Requirements
        ------------
        
        You must have *django-meta* installed and configured, see the
        django-meta_ documentation for details and setup instructions.
        
        Installation
        ============
        
        First install the module, preferably in a virtual environment. It can be installed from PyPI:
        
        .. code-block:: shell
        
            pip install wagtail-metadata-mixin
        
        Setup
        =====
        
        Make sure the project is configured for django-meta_.
        
        Then add the following settings:
        
        .. code-block:: python
        
            INSTALLED_APPS += (
                'wagtailmetadata',
            )
        
        and just include ``meta/meta.html`` template in your templates
        
        .. code-block:: html+django
        
            {% load meta %}
        
            <html {% meta_namespaces_schemaorg %}>
                <head {% meta_namespaces %}>
                    {% include "meta/meta.html" %}
                </head>
                <body>...</body>
            </html>
        
        Usage
        =====
        
        .. code-block:: python
        
            # 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):
                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. :-)
        
        .. _django-meta: https://github.com/nephila/django-meta/
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.0
Classifier: Framework :: Django :: 3.1
Classifier: Framework :: Wagtail
Classifier: Framework :: Wagtail :: 2
Description-Content-Type: text/x-rst
Provides-Extra: develop
Provides-Extra: test
