Social meta tags mixin for django-meta
Project description
Warning
Version 0.2.1 is the last version ever of django-meta-mixin
All the codebase, features and documentation has been moved to https://github.com/nephila/django-meta and it will be released in django-meta 1.0.
django-meta 1.0 is a drop-in replacement for django-meta-mixin: an empty django-meta-mixin 0.3 package will be released together with django-meta-mixin to satisfy dependencies but all the following features and fixes will be released in django-meta.
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 contextInclude 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
Object types
django-meta-mixin ships with the following object types for each set of meta tags it supports:
Generic / OpenGraph
Article
Website
You can override by defining META_OBJECT_TYPES/META_FB_TYPES nested tuples in the project settings like:
META_OBJECT_TYPES = (
('Article', _('Article')),
('Website', _('Website')),
)
META_FB_TYPES = (
('Article', _('Article')),
('Website', _('Website')),
)
Summary Card
Summary Card with Large Image
App Card
You can override by defining META_TWITTER_TYPES nested tuples in the project settings like:
META_TWITTER_TYPES = (
('summary', _('Summary Card')),
('summary_large_image', _('Summary Card with Large Image')),
('app', _('App Card')),
)
Google+ / Schema.org
Article
Blog
WebPage
WebSite
Event
Product
Place
Person
You can override by defining META_GPLUS_TYPES nested tuples in the project settings like:
META_GPLUS_TYPES = (
('Article', _('Article')),
('Blog', _('Blog')),
('WebPage', _('Page')),
('WebSite', _('WebSite')),
('Event', _('Event')),
('Product', _('Product')),
('Place', _('Place')),
('Person', _('Person')),
)
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 (default: first META_OBJECT_TYPES)
og_type: META_FB_TYPE (default: first META_FB_TYPES)
og_app_id: META_FB_APPID (default: blank)
og_profile_id: META_FB_PROFILE_ID (default: blank)
og_publisher: META_FB_PUBLISHER (default: blank)
og_author_url: META_FB_AUTHOR_URL (default: blank)
twitter_type: META_TWITTER_TYPE (default: first META_TWITTER_TYPES)
twitter_site: META_TWITTER_SITE (default: blank)
twitter_author: META_TWITTER_AUTHOR (default: blank)
gplus_type: META_GPLUS_TYPE (default: first META_GPLUS_TYPES)
gplus_author: META_GPLUS_AUTHOR (default: blank)
History
0.2.2 (XXXX-XX-XX)
Use autoescape off in template for Django 1.9
0.2.1 (2015-10-17)
Add object types for facebook, twitter, google plus
Add translations
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.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django_meta_mixin-0.3.0-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1d257a0557382c39c21b1f9cf6da470196e36413824d0b20143a31a566184049 |
|
| MD5 | add4e4f0f60975e162f815c6b6e32d80 |
|
| BLAKE2b-256 | af43f7fa4b37cc28d20498f73ac738249a7757f87e32fb6e63b0e05ab672d650 |
