Skip to main content

Drop-in replacement for staticfiles which handles asset processing.

Project description

Django Assetfiles
=================

Django Assetfiles is a drop-in replacement for staticfiles which handles asset processing.


Installation
------------

1. Install package from PyPi:

``` sh
$ pip install django-assetfiles
```

2. Replace `'django.contrib.staticfiles'` in `INSTALLED_APPS` with `'assetfiles'`:

``` python
INSTALLED_APPS = (
# ...
# 'django.contrib.staticfiles',
'assetfiles',
)
```

3. That's it! Assetfiles will default to your [Staticfiles settings](https://docs.djangoproject.com/en/dev/ref/contrib/staticfiles/).


Usage
-----

1. Add an asset file that should be processed:

``` scss
// static/css/main.scss
$color: red;

body {
color: $color;
}
```

2. Add a link to the processed CSS file in your template (you can use standard Staticfiles conventions):

``` html+django
{% load staticfiles %}
<link href="{% static 'css/main.css' %}" rel="stylesheet">
```

Assetfiles will automatically serve up the processed version of `main.scss` at the static url of `/static/css/main.css`.

4. To serve assets in development, either use `runserver` as normal or add the following to your `urls.py`:

``` python
from assetfiles.urls import assetfiles_urlpatterns

# ... the rest of your URLconf goes here ...

urlpatterns += assetfiles_urlpatterns()
```

5. For deployment, run `collectstatic` as usual and Assetfiles will process and copy over the assets:

``` sh
$ python manage.py collectstatic
$ cat public/css/main.css
body {
color: red; }
```


Copyright
---------

Copyright (c) 2012 [LocalMed, Inc.](http://localmed.com). See LICENSE for details.

Project details


Download files

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

Source Distribution

django-assetfiles-0.8.0.tar.gz (17.3 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page