.. image:: https://drone.io/github.com/danigosa/django-simple-seo/status.png :target: https://drone.io/github.com/danigosa/django-simple-seo/latest
.. image:: https://drone.io/github.com/danigosa/django-simple-seo/files/tests_html/coverage_status.png :target: https://drone.io/github.com/danigosa/django-simple-seo/files/tests_html/index.html
.. image:: https://img.shields.io/pypi/v/django-simple-seo.svg?style=flat :target: https://pypi.python.org/pypi/django-simple-seo
.. image:: https://img.shields.io/pypi/dm/django-simple-seo.svg?style=flat :target: https://pypi.python.org/pypi/django-simple-seo
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.
WARNING
This docs refers to version 1.0 or newer. For older versions (<=0.4.1) refer to:
What's in django-simple-seo
.. image:: assets/simple_seo_admin.png
.. image:: assets/simple_seo_admin1.png
What's NOT in django-simple-seo
You can use pip like this:
.. code-block:: sh
$ pip install django-simple-seo
You can use pip with git master code instead of pypi version:
.. code-block:: sh
$ pip install git+https://github.com/danigosa/django-simple-seo.git
Add to your settings:
.. code-block:: python
INSTALLED_APPS = (
...
'simple_seo',
...
)
Create a model subclassing the classes BaseMetada(title, author, description, keywords), OpenGraphMetada(includes facebook tags) or AllMetadata(Facebook and Twitter).
.. code-block:: python
from simple_seo.models import AllMetadata
class MyMetadata(AllMetadata):
"""
My Seo Model
"""
Synchronize your database with syncdb, then your model with migrate if you are using migrations:
.. code-block:: sh
$ ./manage.py syncdb
Or in case of using South:
.. code-block:: sh
$ ./manage.py schemamigration your_app --auto
$ ./manage.py migrate your_app
Use Django model notation for describing your seo models and the views related to be managed.
The simplest usage is to have just one seo model that manages all views. Do it like this in your settings.py:
.. code-block:: python
SEO_MODEL_REGISTRY = (
('testapp.MyMetadata', 'ALL'),
)
In case you need several seo models a restrict them to certain views, add the following:
.. code-block:: python
SEO_MODEL_REGISTRY = (
('simple_seo.TestMetadata', ('template_test', )),
)
Please note that simple_seo registry will load views by order and store the in a dictionary. That means:
Examples of bad configurations:
.. code-block:: python
SEO_MODEL_REGISTRY = (
('testapp.MyMetadata', 'ALL'),
('simple_seo.TestMetadata', ('template_test', )),
)
PROBLEM: 'simple_seo.TestMetadata' model won't ever be reached. 'template_test' view will be processed with 'testapp.MyMetadata'
.. code-block:: python
SEO_MODEL_REGISTRY = (
('testapp.MyMetadata', ('template_test', )),
# ... More and More definitions
('testapp.MyMetadata', ('template_test2', 'template_test3')),
)
PROBLEM: 'template_test' view will never be processed as last registry overrides first.
There's no plans to make registry very exotic on this, just following very simple rules it can be as complex as you want, covering vast use cases.
Add this lines to your admin.py:
.. code-block:: python
from simple_seo.admin import BaseMetadataAdmin
from django.contrib import admin
from .models import MyMetadata
class MyMetadataAdmin(BaseMetadataAdmin):
pass
admin.site.register(MyMetadata, MyMetadataAdmin)
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:
.. code-block:: python
# Put all your URLconfig that should be managed by simple_seo BEFORE admin
urlpatterns = patterns(
'',
url(r'^test/', template_test, name='template_test'),
)
# Then add admin configuration AFTER your seo views
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.
Your views are autodiscovered for your convenience, create a metadata object for every view you want to administer
.. image:: assets/simple_seo_admin2.png :width: 100%
Just include this template tag in your section, no more template code needed, can be on the root base.html template and it will autodetect the view and inject appropriate metadata for each.
.. code-block:: html
{% load simple_seo %}
<!DOCTYPE html>
<html>
<head lang="en">
<meta charset="UTF-8">
{% view_metadata %}
</head>
<body>
TEST
</body>
</html>
"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:
.. code-block:: python
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)
"I only want Facebook tags, and I prefer to add all fields by hand, no handy population, like a boss"
.. code-block:: python
from simple_seo.fields import URLMetaTagField, MetaTagField
from simple_seo.models import OpenGraphMetadata
from simple_seo import register
class MyOpenGraphMetadata(OpenGraphMetadata):
"""
My OpenGraph Model
"""
og_title = MetaTagField(name="og:title", populate_from=None) # Overrides default og:title field
og_description = MetaTagField(name="og:description", populate_from=None) # Overrides default og:description field
# Register SEO Model
register(MyMetadata)
Some settings are provided to enable caching directly in the app:
.. code-block:: python
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)
You have a complete sample app in testapp module in this repository.
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:
.. code-block:: python
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.
Then add to the root of the project your local_settings.py for everything your need, for instance adding debug toolbar local setting:
.. code-block:: python
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/
version 1.0
version 0.4.1
version 0.3.2
version 0.3.0
version 0.2.4
version 0.2.3
version 0.2.2
Version 0.2.1
Version 0.2
FAQs
Simple SEO Module for Django
We found that django-simple-seo demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.