Skip to main content

A simple Django app for inlining static files in templates.

Project description

django-simpleinliner

A simple Django app for inlining static CSS and JS files in templates. Read CSS, JS or generic files from your static directories and insert them inline into your Django templates, wrapping in appropriate HTML tags if necessary.

Rationale

Provides a quick and easy way to inline an entire JS or CSS file from staticfiles into a template, wrapping it in appropriate tags. django-compressor does this but I wanted something more lightweight, and also wanted to try my hand at writing a Django extension. Some inspiration and staticfile-handling code was taken from django-inlinecss.

Installation

$ pip install django-simpleinliner

Add simpleinliner to your INSTALLED_APPS setting.

Usage

Load the app at the top of your template:

{% load simpleinliner %}

Call inlinecss, inlinejs or inlinegeneric where you want to pull in a static file:

{% inlinejs 'path/to/my.js' %}

{% inlinecss 'path/to/my.css' %}

{% inlinegeneric 'path/to/my.svg' %}

The file will be inserted into the template each time the template is rendered, keeping it up to date.

You can override the default attributes given to <script> and <style> tags generated by simpleinliner by including the following in your project settings:

SIMPLEINLINER_DEFAULT_TAG_ATTRIBUTES = {
    'script': {
        'charset': 'utf-8',
        'type': 'text/javascript',
    },
    'style': {
        'charset': 'utf-8',
        'type': 'text/css',
    },
}

Add or edit these as desired to change the attributes applied to these tags.

By default simpleinliner will silently fail (including an empty tag if using inlinejs or inlinecss) if the specified path doesn't exist. You can force it to raise an exception by setting SIMPLEINLINER_RAISE_EXCEPTIONS to True in your project settings.

Issues, Suggestions, Contributions

...are welcome on GitHub. Thanks for your interest in simpleinliner!

Project details


Release history Release notifications

This version
History Node

0.2.4

History Node

0.2.3

History Node

0.2.2

History Node

0.2.1

History Node

0.2.0

History Node

0.1.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
django-simpleinliner-0.2.4.tar.gz (4.3 kB) Copy SHA256 hash SHA256 Source None May 15, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page