django-meta-mixin

Social meta tags mixin for django-meta

These details have not been verified by PyPI

Project links

Homepage

Project description

https://badge.fury.io/py/django-meta-mixin.png

https://travis-ci.org/nephila/django-meta-mixin.png?branch=master

https://coveralls.io/repos/nephila/django-meta-mixin/badge.png?branch=master

Concepts

django-meta-mixin provides a mixin to handle metadata in your models.

Actual data are evaluated at runtime pulling values from model attributes and methods.

To use it, defines a _metadata attribute as a dictionary of tag/value pairs;

tag is the name of the metatag as used by meta.html template
value is a string that is evaluated in the following order:
- model method name called with the meta attribute as argument
- model method name called with no arguments
- model attribute name (evaluated at runtime)
- string literal (if none of the above exists)

If value is False or it is evaluated as False at runtime the tag is skipped.

To use this mixin you must invoke as_meta() on the model instance for example in the get_context_data().

Request

as_meta() accepts the request object that is saved locally and is available to methods by using the get_request method.

Public interface

ModelMeta.get_meta(request=None): returns the metadata attributes definition. Tipically these are set in _metadata attribute in the model;

ModelMeta.as_meta(request=None): returns the meta representation of the object suitable for use in the template;

ModelMeta.get_request(): returns the request object, if given as argument to as_meta;

ModelMeta.get_author(): returns the author object for the current instance. Default implementation does not return a valid object, this must be overidden in the application according to what is an author in the application domain;

ModelMeta.build_absolute_uri(url): create an absolute URL (i.e.: complete with protocol and domain); this is generated from the request object, if given as argument to as_meta;

Installation

From PyPi:

pip install django-meta-mixin

From github:

pip install -e git+https://github.com/nephila/django-meta-mixin#egg=django-meta-mixin

Usage

Add to installed apps along with django-meta:

INSTALLED_APPS = [
    ...
    'meta',
    'meta_mixin',
]

Configure django-meta according to documentation (https://github.com/nephila/django-meta#configuration)

Add meta information to your model:

from django.db import models
from meta_mixin.models import ModelMeta

class MyModel(ModelMeta, models.Model):
    name = models.CharField(max_length=20)
    abstract = models.TextField()
    ...

    _metadata = {
        'title': 'name',
        'description': 'abstract',
        ...
    }

Push metadata in the context using as_meta method:

class MyView(DetailView):

    ...

    def get_context_data(self, **kwargs):
        context = super(MyView, self).get_context_data(self, **kwargs)
        context['meta'] = self.get_object().as_meta(self.request)
        return context

Include meta_mixin/meta.html template in your templates:

{% load sekizai_tags %}

<html {% render_block 'html_extra' %}>
<head>
    {% include "meta_mixin/meta.html" %}
</head>
<body>
</body>
</html>

Note

For Google+ support you must add {% render_block 'html_extra' %} in your template to add object type definition. See relevant Google+ snippets documentation (https://developers.google.com/+/web/snippet/)

Example

Look at the example folder for a sample implementation.

Available properties

django-meta-mixin currently supports the following properties:

Generic properties

title: object title,
description: generic object description, used for SEO and as default for specific description,
keywords: generic keywords for SEO
locale: advertised object locale (if any)
image: image to display for object
object_type: default object type
published_time: date-time of publishing
modified_time: date-time of modification
expiration_time: date-time of expiration
url: canonical object url

Open Graph properties

og_description: object description in Open Graph
og_type: object type in Open Graph
og_app_id: Facebook App ID
og_profile_id: Author’s Facebook profileID
og_publisher: Facebook URL to publisher’s profile
og_author_url: Facebook URL to author’s profile
tag: object tags

Twitter Cards properties

twitter_description: object description on Twitter card (currently 200 chars max)
twitter_type: twitter card type
twitter_site: Website twitter account
twitter_author: Author twitter account

Google+ Snippet properties

gplus_description: object description
gplus_type: object type according to schema.org types
gplus_author: Author Google+ account

Settings

Some of the above properties can be set either in the model or via settings paramaters

image: META_DEFAULT_IMAGE (must be an absolute URL)
object_type: META_SITE_TYPE
og_type: META_FB_TYPE
og_app_id: META_FB_APPID
og_profile_id: META_FB_PROFILE_ID
og_publisher: META_FB_PUBLISHER
og_author_url: META_FB_AUTHOR_URL
twitter_type: META_TWITTER_TYPE
twitter_site: META_TWITTER_SITE
twitter_author: META_TWITTER_AUTHOR
gplus_type: META_GPLUS_TYPE
gplus_author: META_GPLUS_AUTHOR

History

0.2.0 (2015-10-03)

Add support for using request in extracting metadata
Add one (optional) argument to class method call.
Add support for editorconfig
Add get_meta method to allow customising metadata
Use META_SITE_PROTOCOL when generating full URL
Extend documentation
Clean up the code
Use build_absolute_url instead of make_full_url

0.1.1 (2014-06-20)

Add make_full_url method to retrieve complete object URL.

0.1.0 (2014-04-19)

First release on PyPI.

Project details

These details have not been verified by PyPI

Project links

Homepage

Release history Release notifications | RSS feed

0.3.0

Mar 29, 2016

0.2.1

Oct 17, 2015

This version

0.2.0

Oct 3, 2015

0.1.1

Jun 20, 2014

0.1.0

Apr 19, 2014

Download files

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

Source Distribution

django-meta-mixin-0.2.0.tar.gz (11.7 kB view details)

Uploaded Oct 3, 2015 Source

Built Distribution

django_meta_mixin-0.2.0-py2.py3-none-any.whl (11.7 kB view details)

Uploaded Oct 3, 2015 Python 2 Python 3

File details

Details for the file django-meta-mixin-0.2.0.tar.gz.

File metadata

Download URL: django-meta-mixin-0.2.0.tar.gz
Upload date: Oct 3, 2015
Size: 11.7 kB
Tags: Source
Uploaded using Trusted Publishing? No

File hashes

Hashes for django-meta-mixin-0.2.0.tar.gz
Algorithm	Hash digest
SHA256	`d97e3b84fc336095eef0a72125eda652a1f0283d4fc2eef8cdfefd733af248c0`
MD5	`32eba5b94691f192bd91043bfc69412f`
BLAKE2b-256	`e60b41ce1d21321557851ffd32b08929ebdd843ff5147f5ba9679966fe9c7b70`

See more details on using hashes here.

Provenance

File details

Details for the file django_meta_mixin-0.2.0-py2.py3-none-any.whl.

File metadata

Download URL: django_meta_mixin-0.2.0-py2.py3-none-any.whl
Upload date: Oct 3, 2015
Size: 11.7 kB
Tags: Python 2, Python 3
Uploaded using Trusted Publishing? No

File hashes

Hashes for django_meta_mixin-0.2.0-py2.py3-none-any.whl
Algorithm	Hash digest
SHA256	`98f20da006f1403319558015b53927f9b97bca93d1740a66a8f3275ea86939a1`
MD5	`5f13c81bd474df2b7ceb78f62a825505`
BLAKE2b-256	`cbddc5e9cbabcdc95d80bd144aee2ab342db50836066216e39eefc34e581dd66`