Skip to main content

Painless SEO app for Django framework

Project description

# Django PainlessSEO

[![Code Climate](https://codeclimate.com/github/Glamping-Hub/django-painless-seo/badges/gpa.svg)](https://codeclimate.com/github/Glamping-Hub/django-painless-seo)

A painless way to add SEO information to your Django site.

## Features

This app provides two ways of adding SEO metadata to your django site:

- Absolute paths
- Model instances

It's fully integrated with the admin site including inline forms for models.
It also includes support for multiple languages and localized URLs.

## Requirements

Django >= 1.5.0

## Installation

The Git repository can be cloned with this command:

git clone https://github.com/Glamping-Hub/django-painless-seo.git

The `painlessseo` package included in the distribution should be placed on the
`PYTHONPATH`. Add `painlessseo` to the `INSTALLED_APPS` in your *settings.py*.
Run `syncdb` command to create the needed tables.

## Settings

PainlessSEO uses two configuration variables in order to define the default
information that will be displayed if the URL has no SEO metadata related. You
have to add them to your *settings.py*:

SEO_DEFAULT_TITLE = 'Lorem ipsum title'
SEO_DEFAULT_DESCRIPTION = 'Lorem ipsum description'

### Registering Models

To create synced SEO metadata for model instances you have to define the
`SEO_MODELS` variable in your *settings.py* like this:

SEO_MODELS = (
('myapp', 'mymodel'),
('anotherapp', 'anothermodel'),
)

After registering the models, you can add the inline form to the admin instance
for each model:

from painlessseo.admin import SeoMetadataInline

class MyModelAdmin(admin.ModelAdmin):
inlines = [SeoMetadataInline, ]

Now every time you save a model instance through the admin site, the SEO
metadata will be updated automatically.

## SEO Output

As simple as loading the `seo` template library and using the `get_seo`
template tag like this:

{% load seo %}

<head>
{% get_seo %}
</head>

## Notes

[Why PainlessSEO does not include keywords meta tag](http://googlewebmastercentral.blogspot.in/2009/09/google-does-not-use-keywords-meta-tag.html).

## Legal Stuff

This software is licensed under the terms of the BSD 3-clause license. You can
find the whole text of the license in the LICENSE file.


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-painless-seo-0.1.0.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

django_painless_seo-0.1.0-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

Details for the file django-painless-seo-0.1.0.tar.gz.

File metadata

File hashes

Hashes for django-painless-seo-0.1.0.tar.gz
Algorithm Hash digest
SHA256 acf82058ba58c2a9ea7c1b4eac83a6555f617f1cced82c971141411a1ba41a22
MD5 bf3091e71586ad3710b6d2e1cbc6456a
BLAKE2b-256 6cceb7ebf64ede4b4f15acc7a510bf5c41950c21938e710ccc97efcd92b39f2c

See more details on using hashes here.

File details

Details for the file django_painless_seo-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_painless_seo-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b43a5e0a68ffec8cabc17c9a7a1c195d53f2090c446bbf6ab07006e7c4a5d40c
MD5 839dc04cbcbf01652b1ce2e8073b2305
BLAKE2b-256 d3c8a035751ea11e0cf2767aa2e42745cd8ce28498b60cf4356f2a69e54cc2d1

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