Django template tags to compile all kinds of static files (SASS, LESS, CoffeeScript).
Project description
Django Static Precompiler
Django Static Precompiler provides template tags to compile CoffeeScript, SASS / SCSS and LESS. It works with both inline code and extenal files.
Installation
Add “static_precompiler” to INSTALLED_APPS setting.
Run syncdb or migrate static_precompiler if you use South.
Make sure that you have necessary compilers installed.
Optionally, you can specify the full path to compilers (for example SCSS_EXECUTABLE='/usr/local/bin/sass').
In case you use Django’s staticfiles contrib app you have to add static-precompiler’s file finder to the STATICFILES_FINDERS setting, for example:
STATICFILES_FINDERS = ( 'django.contrib.staticfiles.finders.FileSystemFinder', 'django.contrib.staticfiles.finders.AppDirectoriesFinder', # other finders.. 'static_precompiler.finders.StaticPrecompilerFinder', )
Note that by default compiled files are saved into COMPILED folder under your STATIC_ROOT (or MEDIA_ROOT if you have no STATIC_ROOT in your settings). You can change this folder with STATIC_PRECOMPILER_ROOT and STATIC_PRECOMPILER_OUTPUT_DIR settings.
Note that all relative URLs in your stylesheets are converted to absolute URLs using your STATIC_URL setting.
General settings
- STATIC_PRECOMPILER_COMPILERS
List of enabled compilers. You can modify it to enable your custom compilers. Default:
( "static_precompiler.compilers.CoffeeScript", "static_precompiler.compilers.SASS", "static_precompiler.compilers.SCSS", "static_precompiler.compilers.LESS", )
- STATIC_PRECOMPILER_ROOT
Controls the absolute file path that compiled files will be written to. Default: STATIC_ROOT.
- STATIC_PRECOMPILER_OUTPUT_DIR
Controls the directory inside STATIC_PRECOMPILER_ROOT that compiled files will be written to. Default: "COMPILED".
- STATIC_PRECOMPILER_USE_CACHE
Whether to use cache for inline compilation. Default: True.
- STATIC_PRECOMPILER_CACHE_TIMEOUT
Cache timeout for inline styles (in seconds). Default: 30 days.
- STATIC_PRECOMPILER_MTIME_DELAY
Cache timeout for reading the modification time of source files (in seconds). Default: 10 seconds.
CoffeeScript
Settings
- COFFEESCRIPT_EXECUTABLE
Path to CoffeeScript compiler executable. Default: "coffee".
Example Usage
Inline CoffeeScript:
{% load coffeescript %} <script type="text/javascript"> {% inlinecoffeescript %} console.log "Hello, World!" {% endinlinecoffeescript %} </script>
renders to:
<script type="text/javascript"> (function() { console.log("Hello, World!"); }).call(this); </script>
External file:
{% load coffeescript %} <script type="text/javascript" src="{{ STATIC_URL}}{% coffeescript "path/to/script.coffee" %}"> </script>
renders to:
<script type="text/javascript" src="/media/COFFEESCRIPT_CACHE/path/to/script-91ce1f66f583.js"> </script>
SASS / SCSS
Settings
- SCSS_EXECUTABLE
Path to SASS compiler executable. Default: “sass”.
- SCSS_USE_COMPASS
Boolean. Wheter to use compass or not. Compass must be installed in your system. Run “sass –compass” and if no error is shown it means that compass is installed.
Example Usage
Inline SCSS:
{% load scss %} <style> {% inlinescss %} #header { h1 { font-size: 26px; font-weight: bold; } p { font-size: 12px; a { text-decoration: none; &:hover { border-width: 1px } } } } {% endinlinescss %} </style>
renders to:
<style> #header h1 { font-size: 26px; font-weight: bold; } #header p { font-size: 12px; } #header p a { text-decoration: none; } #header p a:hover { border-width: 1px; } </style>
External file:
{% load scss %} <link rel="stylesheet" href="{{ STATIC_URL}}{% scss "path/to/styles.scss" %}" />
renders to:
<link rel="stylesheet" href="/media/COMPILED/path/to/styles.css" />
LESS
Settings
- LESS_EXECUTABLE
Path to LESS compiler executable. Default: "lessc".
Example Usage
Inline LESS:
{% load less %} <style> {% inlineless %} #header { h1 { font-size: 26px; font-weight: bold; } p { font-size: 12px; a { text-decoration: none; &:hover { border-width: 1px } } } } {% endinlineless %} </style>
renders to:
<style> #header h1 { font-size: 26px; font-weight: bold; } #header p { font-size: 12px; } #header p a { text-decoration: none; } #header p a:hover { border-width: 1px; } </style>
External file:
{% load less %} <link rel="stylesheet" href="{{ STATIC_URL}}{% less "path/to/styles.less" %}" />
renders to:
<link rel="stylesheet" href="/media/COMPILED/path/to/styles.css" />
static_precompiler_watch
Django Static Precompiler includes a management command static_precompiler_watch. It monitors the change in your source files and re-compiles them on the fly. It can be handy if you use tools such as LiveReload.
You should install Watchdog to use this command.
Changes
0.1
Initial release
Project details
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
Hashes for django-static-precompiler-0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b7dc5c668980f2ba3225fb4c7baf777a45c926541405ed896fa608f3b1527c88 |
|
MD5 | 0d5de61855ffbcbe8849a971c62bbabd |
|
BLAKE2b-256 | 680cba15a146de21455d60a6f589ba977ec41d9a8a9c64485caedf9ac6f7ab07 |