SASS processor to compile SCSS files into *.css, while rendering, or offline.
Project description
Processor to compile files from markup languages such as SASS/SCSS, if referenced using the templatetag {% sass_src 'path/to/file.scss' %}. This special templatetag can be used instead of the built-in tag static.
Additionally, django-sass-processor is shipped with a management command, which can convert the content of all occurrences inside the templatetag sass_src as an offline operation. Hence the libsass compiler is not required in a production environment.
During development, a sourcemap is generated along side with the compiled *.css file. This allows to debug style sheet errors much easier.
With this tool, you can safely remove your Ruby installations “Compass” and “SASS” from your Django projects.
Project’s Home
On GitHub:
https://github.com/jrief/django-sass-processor
Please use the issue tracker to report bugs or propose new features.
Installation
pip install libsass django-compressor django-sass-processor
django-compressor is required only for offline compilation, when using the command manage.py compilescss.
libsass is not required on the production environment, if SASS/SCSS files have been precompiled and deployed using offline compilation.
Configuration
In settings.py add to:
INSTALLED_APPS = (
...
'sass_processor',
...
)Optionally, add a list of additional search paths, the SASS compiler may examine when using the @import "..."; statement in SASS/SCSS files:
import os
SASS_PROCESSOR_INCLUDE_DIRS = (
os.path.join(PROJECT_PATH, 'mystyles/scss'),
os.path.join(PROJECT_PATH, 'node_modules'),
)During development, or when SASS_PROCESSOR_ENABLED is set to True, the compiled file is placed into the folder referenced by SASS_PROCESSOR_ROOT (if unset, this setting defaults to STATIC_ROOT). Having a location outside of the working directory prevents to pollute your local static/css/... folders with auto-generated files. Therefore assure, that this directory is writable by the Django runserver.
django-sass-processor is shipped with a special finder, to locate the generated *.css files in the folder referred by SASS_PROCESSOR_ROOT (or, if unset STATIC_ROOT). Just add it to your settings.py:
STATICFILES_FINDERS = (
...
'sass_processor.finders.CssFinder',
...
)
Preprocessing SASS
django-sass-processor is shipped with a built-in preprocessor to convert *.scss or *.sass files into *.css while rendering the template. For performance reasons this is done only once, but the preprocessor keeps track on the timestamps and recompiles, if any of the imported SASS/SCSS files is younger than the corresponding generated CSS file.
In your Django templates
{% load sass_tags %}
<link href="{% sass_src 'myapp/css/mystyle.scss' %}" rel="stylesheet" type="text/css" />You can safely use this templatetag inside a Sekizai’s {% addtoblock "css" %} statement.
Offline compilation
If you want to precompile all occurrences of your SASS/SCSS files for the whole project, on the command line invoke:
./manage.py compilescss
This is useful for preparing production environments, where SASS/SCSS files can’t be compiled on the fly. To simplify the deployment, the compiled *.css files are stored side-by-side with their corresponding SASS/SCSS files; just run ./manage.py collectstatic afterwards. In case you don’t want to expose the SASS/SCSS files in a production environment, deploy with ./manage.py collectstatic --ignore=.scss.
In case you want to get rid of the compiled *.css files in your local static directories, simply reverse the above command:
./manage.py compilescss --delete-files
This will remove all occurrences of previously generated *.css files.
History
0.2.0 Removed dependency to django-sekizai and django-classy-tags. It now can operate in stand-alone mode. Therefore the project has been renamed to django-sass-processor.
0.1.0 Initial revision named django-sekizai-processors, based on a preprocessor for the Sekizai template tags {% addtoblock %}.
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-sass-processor-0.2.3.tar.gz.
File metadata
- Download URL: django-sass-processor-0.2.3.tar.gz
- Upload date:
- Size: 13.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 91a5c4cdf1f5e304613306d2b52f44b5417b50f3aa6994a12139722831dd00e4 |
|
| MD5 | b7cc7ba402fd0e9825555c931bbe0529 |
|
| BLAKE2b-256 | d438e3dd1fbc90f6336f3cb40258a8e18c99eb748b119a7314adc000016deedf |
