Aldryn Snake adds tail and head context processors for addons similar to django-sekizai
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
aldryn_snake
tests
.coveragerc
.editorconfig
.gitignore
.travis.yml
CHANGELOG.rst
LICENSE.txt
MANIFEST.in
README.rst
addon.json
aldryn_config.py
setup.py
tox.ini

README.rst

Aldryn Snake

pypi build coverage

Aldryn Snake adds tail and head context processors for addons similar to django-sekizai.

This addon still uses the legacy "Aldryn" naming. You can read more about this in our support section.

Contributing

This is a an open-source project. We'll be delighted to receive your feedback in the form of issues and pull requests. Before submitting your pull request, please review our contribution guidelines.

We're grateful to all contributors who have helped create and maintain this package. Contributors are listed at the contributors section.

Documentation

See REQUIREMENTS in the setup.py file for additional dependencies:

python django

Installation

  • add aldryn_snake.template_api.template_processor to your TEMPLATE_CONTEXT_PROCESSORS settings

  • somewhere in your app (that will be imported on startup (models, admin etc) add something to the api:

    # -*- coding: utf-8 -*-
    from aldryn_snake.template_api import registry
    from django.conf import settings
    
    OPTIMIZELY_SCRIPT = """<script src="//cdn.optimizely.com/js/%(account_number)s.js"></script>"""
    
    
    def get_crazyegg_script():
      optimizely_number = getattr(settings, 'OPTIMIZELY_ACCOUNT_NUMBER', None)
      if optimizely_number:
          return OPTIMIZELY_SCRIPT % {'account_number': optimizely_number}
       else:
          return ''
    
    registry.add_to_tail(get_crazyegg_script())
    

If add_to_tail or add_to_head receive a callable, it will be called with the request keyword argument.

  • add the following in your base template to the HEAD:

    {{ ALDRYN_SNAKE.render_head }}
    
  • add the following in your base template right above </BODY>:

    {{ ALDRYN_SNAKE.render_tail }}
    

Running Tests

You can run tests by executing:

virtualenv env
source env/bin/activate
pip install -r tests/requirements.txt
python setup.py test