Simple SEO Module for Django
Project description
Simple seo backend for Django. Inspired by django-seo ( https://github.com/willhardy/django-seo ) but found it quite complex for the simple functionality it was intended for.
django-simple-seo aims to attach a model to your views with just 4 simple lines of code and everything configured by the admin.
What’s in django-simple-seo
Python 2.7, 3.2, 3.3, 3.4 and Django 1.4, 1.5 and 1.6
View Autodiscovering
Pure Django Models and Django Fields implementation, no metaclasses in action
Don’t reinvent the wheel: as long as they are django models you can use the goodies out there
i18n with django-vinaigrette, django-linguo, django-modeltranslation, etc.
Cache can be activated internally, but can also be used with johnny-cache, django-cache-machine, etc.
Easily extendible as far as it’s all about simple django models and fields
Out-of-the-box models for OpenGraph Facebook and Twitter tags
Support for UrlFields and ImageFields in admin
Includes Selenium tests for proper HTML generation
Test app included (.testapp)
What’s NOT in django-simple-seo
Only implements view based backend. Maybe in future releases it will include Model and Path backend like in DjangoSeo. The attribute ‘populate_from’ is neither implemented yet.
Installation
You can use pip like this:
$ pip install django-simple-seoYou can use pip with git master code instead of pypi version:
$ pip install git+https://github.com/danigosa/django-simple-seo.gitAdd to your settings:
INSTALLED_APPS = (
...
'simple_seo',
...
)Requeriments
staticfiles
south (optional, if migrations)
admin (this includes auth, sessions and contenttypes)
1. Create your SEO Model
Create a model subclassing the classes BaseMetada(title, author, description, keywords), OpenGraphMetada(includes facebook tags) or AllMetadata(Facebook and Twitter). You must use register to register the model.
from simple_seo.models import AllMetadata
from simple_seo import register
class MyMetadata(AllMetadata):
"""
My Seo Model
"""
# Register SEO Model
register(MyMetadata)2. Synchronize your DB
Synchronize your database with syncdb, then your model with migrate if you are using migrations:
$ ./manage.py syncdb3. Register your model for administration
Add this lines to your admin.py:
from simple_seo.admin import BaseMetadataAdmin
from django.contrib import admin
from .models import MyMetadata
class MyMetadataAdmin(BaseMetadataAdmin):
pass
admin.site.register(MyMetadata, MyMetadataAdmin)4. Configure URLs for autodiscover
WARNING: It’s a django related issue but once you call admin.autodiscover() the URLConf module remains corrupted forever, that means cannot dive into urlpatterns.
To solve that, try to add admin URL and do autodiscovering at the very end of your urls.py like this:
admin.autodiscover()
urlpatterns += patterns(
'',
url(r'^admin/', include(admin.site.urls)),
)This will avoid autodiscover admin views, and also to see your actual views urlpatterns.
5. Add metadata for your views
Your views are autodiscovered for your convenience, create a metadata object for every view you want to administer
6. Add metadata to your template
Just include this template tag in your <head> section:
{% load simple_seo %}
<!DOCTYPE html>
<html>
<head lang="en">
<meta charset="UTF-8">
{% view_metadata %}
</head>
<body>
TEST
</body>
</html>7. Extend/Override default behaviour
“I prefer to have images as URLs, not static files in my server”
Just override og_image attribute. You can find all base models in simple_seo.models, and all tag fields in simple_seo.fields:
from simple_seo.fields import URLMetaTagField, MetaTagField
from simple_seo.models import AllMetadata
from simple_seo import register
class MyMetadata(AllMetadata):
"""
My Seo Model
"""
og_image = URLMetaTagField(name="og:image") # Overrides default og:image field
another_meta_tag = MetaTagField(name="myvariable", max_length="25") # Creates a new custom meta tag for the views
# Register SEO Model
register(MyMetadata)8. Cache Settings
Some settings are provided to enable caching directly in the app:
SEO_CACHE_PREFIX = getattr(settings, 'SEO_CACHE_PREFIX', 'simple_seo:')
SEO_CACHE_TIMEOUT = getattr(settings, 'SEO_CACHE_PREFIX', 60 * 60 * 24)
SEO_USE_CACHE = getattr(settings, 'SEO_CACHE_PREFIX', False)9. Sample App
You have a complete sample app in testapp module in this repository.
10. Multilang i18n Support
As said before you can apply any 3rd party app for translating your models to django-simple-seo models. As an example, this is a complete model translated thanks to django-vinaigrette app: https://github.com/ecometrica/django-vinaigrette
Complete SEO model translated:
from simple_seo.models import AllMetadata
from simple_seo import register
import vinaigrette
class SiteMetadata(AllMetadata):
"""
Site Metadata
"""
class Meta:
app_label = 'web'
# Register SEO Model
register(SiteMetadata)
vinaigrette.register(
SiteMetadata,
[
'title',
'description',
'keywords',
'author',
'og:title',
'og:description',
'twitter:title',
'twitter:description',
]
)After that, just run ./manage.py makemessages and you’re done. See django-vinaigrette for more details.
10. Contribute!
Then add to the root of the project your local_settings.py for everything your need, for instance adding debug toolbar local setting:
INTERNAL_IPS = ('10.0.2.2', )To execute the project with vagrant and virtualbox you can add this Vagrantfile and receipes to the local project and execute vagrant up:
https://gist.github.com/danigosa/c2ac2d349c4fcf823cb7
After box is provisioned you’ll have an Ubuntu 14.04 with a Python 3.4 virtualenv.
You can find more info of how to develop with remote vagrant servers and the awesome Pycharm IDE here: http://codeispoetry.me/index.php/remote-server-with-pycharm-and-vagrant/
Changelog
version 0.4.1
Refactors and bugfixings
Support for modeltranslation and linguo i18n backends
version 0.3.2
Bugfixes in __str__ and __len__ when fields have NULL value in database
version 0.3.0
Bugfixes
Added tests integrated with Selenium for proper HTML generation
version 0.2.4
Bugfix error in print_tag that did not printed images and urls in templatetag
version 0.2.3
Bugfix error in caching when i18n activated
version 0.2.2
Bugfix errors in view autodiscover in some cases
Version 0.2.1
Bugfixes
Support for South Migrations
Version 0.2
Added support for namespaced views
Added support for ImageField based Image Metatags (og:image, twitter:image)
Added support for UrlField based URL Metatags (og:url, twitter:url)
Added more base classes to ease setup
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file django-simple-seo-0.4.1.tar.gz.
File metadata
- Download URL: django-simple-seo-0.4.1.tar.gz
- Upload date:
- Size: 11.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6abeb57c43e11b3328f98d2c51dffc3e3f89acaf5877228e032df564db85391e |
|
| MD5 | 4d13ae2379f8354cae8a9f34e87d37a3 |
|
| BLAKE2b-256 | 93e7b18391ab16eccf716dec6ddce8dc44635d44b870595158e133d6a83a9011 |
