Skip to main content

The django application allows to add title, keywords and description meta tags to site's pages.

Project description

https://secure.travis-ci.org/whitespy/django-simple-metatags.svg https://badge.fury.io/py/django-simple-metatags.svg https://codecov.io/gh/whitespy/django-simple-metatags/branch/master/graph/badge.svg

The django application allows to add title, keywords and description meta tags to site’s pages.

Features

  • Attaching meta tags to model instances

  • Attaching meta tags to URL paths

  • Caching

  • Integration with the django-modeltranslation application

Installation

pip install django-simple-metatags

Configuration

  1. Add ‘metatags’ to your INSTALLED_APPS:

INSTALLED_APPS = (
    # ...
    'metatags',
)
  1. Run the migrate management command:

python manage.py migrate metatags
  1. Customize model admin classes:

To be able to attach meta tags to a model instance you should slightly adjust a model admin class.

The first way by adding the MetaTagInline class in inlines sequence:

from metatags.admin import MetaTagInline


class CustomModelAdmin(admin.ModelAdmin):
    # ...
    inlines = (MetaTagInline,)

The second way by using MetaTagAbleMixin:

from metatags.admin import MetaTagAbleMixin


class CustomModelAdmin(MetaTagAbleMixin, admin.ModelAdmin):
    # ...

The third and way by using MetaTagAbleModelAdmin:

from metatags.admin import MetaTagAbleModelAdmin


class CustomModelAdmin(MetaTagAbleModelAdmin):
    # ...
  1. Load the metatags template library and add the include_metatags template tag in template.

Add the include_metatags template tag with the model_instance argument to use meta tags attached to a model instance.

{% load metatags %}
<head>
    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
    {% include_metatags object default_title='Foo' default_keywords='Foo, bar, baz' %}
</head>

Add the include_metatags without the model_instance argument to use meta tags attached to an URL path.

{% load metatags %}
<head>
    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
    {% include_metatags default_title='Foo' default_keywords='Foo, bar, baz' %}
</head>

Arguments of include_metatags template tag

All arguments are optional.

model_instance - A model instance with attached meta tags. Defaults to None.

default_title - A default title of page. Defaults to ‘’.

default_keywords - Default keywords of page. Defaults to ‘’.

default_description - Default description of page. Defaults to ‘’.

Caching

Since version 2.0.0 application gained caching support. See settings section for more details.

Settings

METATAGS_CACHE_ENABLED - Enables meta tags caching to minimize database access. Defaults to False.

METATAGS_CACHE_ALIAS - A name of cache backend used by meta tags caching feature. Defaults to default.

METATAGS_CACHE_TIMEOUT - Timeout in seconds to use for meta tags caching. If value set up to None cached meta tags never expire. Defaults to None.

Management command

resetmetatagscache - Removes all cached meta tags.

Project details


Download files

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

Source Distribution

django-simple-metatags-2.0.0.tar.gz (12.2 kB view details)

Uploaded Source

Built Distribution

django_simple_metatags-2.0.0-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

Details for the file django-simple-metatags-2.0.0.tar.gz.

File metadata

File hashes

Hashes for django-simple-metatags-2.0.0.tar.gz
Algorithm Hash digest
SHA256 d52ade9a6df9a2b46a0dd5ed9ffa99249e195f1c3b9e25790ecb1c8b9bc2b89f
MD5 472ac9556a4a37fa9a86c83677ae6508
BLAKE2b-256 1ba8e1c7f1ad26616e3b6ed8f1d6d0f55b19695b2a566a53c988d97d747a6ec9

See more details on using hashes here.

File details

Details for the file django_simple_metatags-2.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_simple_metatags-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 41e82c2855102e29aa09de4ff9ff49455ed6aa3517626439184c2e9140199b58
MD5 4f4a9b02b1f3e06ee097c94ffd88c05a
BLAKE2b-256 f9facb276c280f8888bf71f037a2ea352c64bc8cc351ea74d5945edeca4be9cb

See more details on using hashes here.

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